Netter ontology-query API

The ontology-query API from Netter — 1 operation(s) for ontology-query.

OpenAPI Specification

netter-ontology-query-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: DMI Backend actions ontology-query API
  version: 0.1.0
tags:
- name: ontology-query
paths:
  /api/v1/ontology/query:
    post:
      tags:
      - ontology-query
      summary: Query Entities
      description: Execute a natural language query over the entity ontology.
      operationId: query_entities_api_v1_ontology_query_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Query Entities Api V1 Ontology Query Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    QueryRequest:
      properties:
        question:
          type: string
          title: Question
      type: object
      required:
      - question
      title: QueryRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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