Compresr On-Prem API

The On-Prem API from Compresr — 1 operation(s) for on-prem.

OpenAPI Specification

compresr-on-prem-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Compresr Platform Admin On-Prem API
  version: 1.0.0
tags:
- name: On-Prem
paths:
  /api/v1/onprem/validate-key:
    get:
      tags:
      - On-Prem
      summary: Validate Key
      operationId: validate_key_api_v1_onprem_validate_key_get
      security:
      - HTTPBearer: []
      parameters:
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
          title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateKeyResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ValidateKeyResponse:
      properties:
        valid:
          type: boolean
          title: Valid
        user_id:
          type: string
          title: User Id
        scope:
          type: string
          title: Scope
      type: object
      required:
      - valid
      - user_id
      - scope
      title: ValidateKeyResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer