openapi.json

{
  "openapi": "3.0.3",
  "info": {
    "version": "1.0.0",
    "title": "LFS Checkdigit API",
    "license": {
      "name": "MIT",
      "url": "https://github.com/epg-apg/lfs-checkdigit-api/blob/main/LICENSE"
    }
  },
  "servers": [
    {
      "url": "https://lfs-checkdigit-api.herokuapp.com/"
    }
  ],
  "paths": {
    "/number/{number}": {
      "get": {
        "summary": "Return check digit for number",
        "tags": [],
        "parameters": [
          {
            "name": "number",
            "in": "path",
            "description": "Number for which the check-digit is calculated",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "CheckDigit object",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CheckDigit"
                }
              }
            }
          },
          "default": {
            "description": "unexpected error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "CheckDigit": {
        "type": "object",
        "required": [
          "CheckDigit"
        ],
        "properties": {
          "checkDigit": {
            "type": "integer",
            "format": "int64"
          },
          "number": {
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "Error": {
        "type": "object",
        "required": [
          "code",
          "message"
        ],
        "properties": {
          "code": {
            "type": "integer",
            "format": "int32"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}