OpsMill Schema.graphql API

The Schema.graphql API from OpsMill — 1 operation(s) for schema.graphql.

OpenAPI Specification

opsmill-schema-graphql-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Infrahub Artifact Schema.graphql API
  version: 1.10.0
tags:
- name: Schema.graphql
paths:
  /schema.graphql:
    get:
      summary: Get Graphql Schema
      operationId: get_graphql_schema_schema_graphql_get
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
      parameters:
      - name: sorted
        in: query
        required: false
        schema:
          type: boolean
          description: Whether to sort the schema alphabetically.
          default: false
          title: Sorted
        description: Whether to sort the schema alphabetically.
      - name: branch
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Name of the branch to use for the query
          title: Branch
        description: Name of the branch to use for the query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Schema.graphql
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
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-INFRAHUB-KEY