{
  "openapi": "3.1.0",
  "info": {
    "title": "FermiHDI Services API",
    "summary": "API for used to work with FermiHDI directly",
    "description": "This API provides endpoints for managing a client relationship with FermiHDI",
    "termsOfService": "https://api.fermihdi.io/terms-of-service",
    "contact": {
      "name": "FermiHDI HD Support Team",
      "url": "https://support.fermihdi.com",
      "email": "support@fermihdi.com"
    },
    "license": {
      "name": "UNLICENSED"
    },
    "version": "0.1.0"
  },
  "jsonSchemaDialect": "https://spec.openapis.org/oas/3.1/dialect/base",
  "servers": [],
  "paths": {
    "/api/v1/license": {
      "post": {
        "summary": "Get License",
        "description": "This endpoint retrieves a client license and any required data or files",
        "requestBody": {
          "description": "License Request",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/licenseRequest"
              },
              "example": {}
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "License request successful",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/licenseResponse"
                }
              }
            }
          },
          "400": {
            "description": "License request error",
            "content": {
              "application/json": {
                "schema": {
                  "description": "The JSON Schema description for reporting an Error in license request",
                  "type": "object",
                  "properties": {
                    "statusCode": {
                      "description": "The HTTP error code",
                      "type": "integer"
                    },
                    "error": {
                      "description": "Type of the error",
                      "type": "string"
                    },
                    "message": {
                      "description": "The error message",
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "security": [],
  "components": {
    "schemas": {
      "GeneralError": {
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "format": "int32"
          },
          "message": {
            "type": "string"
          }
        }
      },
      "licenseRequest": {
        "externalDocs": {
          "description": "The JSON Schema for the request a license",
          "url": "https://schemas.fermihdi.io/license_request_schema.json"
        }
      },
      "licenseResponse": {
        "externalDocs": {
          "description": "The JSON Schema for a successful license request",
          "url": "https://schemas.fermihdi.io/license_request_response_schema.json"
        }
      }
    }
  }
}
