Netter ontology-traversal API

openapi: 3.1.0
info:
  title: DMI Backend actions ontology-traversal API
  version: 0.1.0
tags:
- name: ontology-traversal
paths:
  /api/v1/ontology/entities/{entity_id}/related:
    get:
      tags:
      - ontology-traversal
      summary: Get Related Entities
      description: Get the connected entity subgraph from this entity.
      operationId: get_related_entities_api_v1_ontology_entities__entity_id__related_get
      parameters:
      - name: entity_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Entity Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RelatedEntity'
                title: Response Get Related Entities Api V1 Ontology Entities  Entity Id  Related Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    RelatedEntity:
      properties:
        entity_id:
          type: string
          format: uuid
          title: Entity Id
        name:
          type: string
          title: Name
        display_name:
          type: string
          title: Display Name
        record_count:
          type: integer
          title: Record Count
        relationship_name:
          type: string
          title: Relationship Name
        relationship_type:
          type: string
          title: Relationship Type
        cardinality:
          type: string
          title: Cardinality
        direction:
          type: string
          title: Direction
      type: object
      required:
      - entity_id
      - name
      - display_name
      - record_count
      - relationship_name
      - relationship_type
      - cardinality
      - direction
      title: RelatedEntity
      description: An entity in the connected subgraph.
    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