SmartMind schema API

The schema API from SmartMind — 2 operation(s) for schema.

OpenAPI Specification

smartmind-schema-api-openapi.yml Raw ↑
openapi: 3.0.2
info:
  title: THANOSQL api file schema API
  description: THANOSQL TEST API documentation
  version: '1.0'
tags:
- name: schema
paths:
  /api/v1/schema/:
    get:
      tags:
      - schema
      summary: Get Schemas
      description: 'Gets all the schemas from the database.


        Returns

        -------

        A SchemasResponse Pydantic object containing a List of

        Table Schema objects.'
      operationId: get_schemas_api_v1_schema__get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemasResponse'
      security:
      - Bearer Auth: []
  /api/v1/schema/{schema}:
    post:
      tags:
      - schema
      summary: Create Schema
      operationId: create_schema_api_v1_schema__schema__post
      parameters:
      - required: true
        schema:
          title: Schema
          type: string
        name: schema
        in: path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - Bearer Auth: []
components:
  schemas:
    Schema:
      title: Schema
      required:
      - name
      type: object
      properties:
        name:
          title: Name
          type: string
    ValidationError:
      title: ValidationError
      required:
      - loc
      - msg
      - type
      type: object
      properties:
        loc:
          title: Location
          type: array
          items:
            anyOf:
            - type: string
            - type: integer
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
    HTTPValidationError:
      title: HTTPValidationError
      type: object
      properties:
        detail:
          title: Detail
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
    SchemasResponse:
      title: SchemasResponse
      required:
      - schemas
      type: object
      properties:
        schemas:
          title: Schemas
          type: array
          items:
            $ref: '#/components/schemas/Schema'
  securitySchemes:
    Bearer Auth:
      type: apiKey
      in: header
      name: Authorization
      description: 'Enter: **''Bearer <JWT>''**, where JWT is the access token. Example: Bearer access_token_comes_here'