swagger.json

{
    "swagger": "2.0",
    "info": {
        "version": "1.0.0",
        "title": "Operator ICT test API",
        "description": "A simple test API",
        "license": {
            "name": "MIT",
            "url": "https://opensource.org/licenses/MIT"
        }
    },
    "basePath": "/",

    "schemes": [
        "http"
    ],
    "consumes": [
        "application/json"
    ],
    "produces": [
        "application/json"
    ],
    "paths": {
        "/status/": {
            "parameters": [],
            "get": {
                "tags": [
                    "Get application status"
                ],
                "summary": "Get application status",
                "responses": {
                    "200": {
                        "description": "Status returned"
                    },
                    "500": {
                        "description": "Internal server error"
                    }
                }
            }
        },
        "/cards/{cardId}": {
            "parameters": [
                {
                    "name": "cardId",
                    "in": "path",
                    "required": true,
                    "description": "ID of card",
                    "type": "integer"
                },
                {
                    "name": "Authorization",
                    "in": "header",
                    "required": true,
                    "description": "Working example: Basic YWRtaW46cm9vdA==",
                    "type": "string"
                }
            ],
            "get": {
                "tags": [
                    "Get card info"
                ],
                "summary": "Get information about card with given ID",
                "security": [
                    {
                        "basicAuth": []
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Information about card returned"
                    },
                    "401": {
                        "description": "Unauthorized"
                    },
                    "500": {
                        "description": "Internal server error"
                    }
                }
            }
        }
    },

    "definitions": {
        "CardResponse": {
            "properties": {
                "validityEnd": {
                    "type": "string"
                },
                "stateDescription": {
                    "type": "string"
                }
            }
        }
    }
}