Alation Governance API — Glossary Terms

naftiko: 1.0.0-alpha2
info:
  label: Alation Governance API — Glossary Terms
  description: 'Alation Governance API — Glossary Terms. 5 operations. Lead operation: List glossary terms. Self-contained
    Naftiko capability covering one Alation business surface.'
  tags:
  - Alation
  - Glossary Terms
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ALATION_API_KEY: ALATION_API_KEY
capability:
  consumes:
  - type: http
    namespace: governance-glossary-terms
    baseUri: https://{instance}/integration/v2
    description: Alation Governance API — Glossary Terms business capability. Self-contained, no shared references.
    resources:
    - name: glossary_term
      path: /glossary_term/
      operations:
      - name: listglossaryterms
        method: GET
        description: List glossary terms
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
        - name: skip
          in: query
          type: integer
        - name: search
          in: query
          type: string
          description: Search term to filter glossary terms
      - name: createglossaryterm
        method: POST
        description: Create a glossary term
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: glossary_term-id
      path: /glossary_term/{id}/
      operations:
      - name: getglossaryterm
        method: GET
        description: Get a glossary term
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
      - name: updateglossaryterm
        method: PUT
        description: Update a glossary term
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteglossaryterm
        method: DELETE
        description: Delete a glossary term
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          required: true
    authentication:
      type: bearer
      token: '{{env.ALATION_API_KEY}}'
  exposes:
  - type: rest
    namespace: governance-glossary-terms-rest
    port: 8080
    description: REST adapter for Alation Governance API — Glossary Terms. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/glossary-term
      name: glossary-term
      description: REST surface for glossary_term.
      operations:
      - method: GET
        name: listglossaryterms
        description: List glossary terms
        call: governance-glossary-terms.listglossaryterms
        with:
          limit: rest.limit
          skip: rest.skip
          search: rest.search
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createglossaryterm
        description: Create a glossary term
        call: governance-glossary-terms.createglossaryterm
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/glossary-term/{id}
      name: glossary-term-id
      description: REST surface for glossary_term-id.
      operations:
      - method: GET
        name: getglossaryterm
        description: Get a glossary term
        call: governance-glossary-terms.getglossaryterm
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateglossaryterm
        description: Update a glossary term
        call: governance-glossary-terms.updateglossaryterm
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteglossaryterm
        description: Delete a glossary term
        call: governance-glossary-terms.deleteglossaryterm
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: governance-glossary-terms-mcp
    port: 9090
    transport: http
    description: MCP adapter for Alation Governance API — Glossary Terms. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-glossary-terms
      description: List glossary terms
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: governance-glossary-terms.listglossaryterms
      with:
        limit: tools.limit
        skip: tools.skip
        search: tools.search
      outputParameters:
      - type: object
        mapping: $.
    - name: create-glossary-term
      description: Create a glossary term
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: governance-glossary-terms.createglossaryterm
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-glossary-term
      description: Get a glossary term
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: governance-glossary-terms.getglossaryterm
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-glossary-term
      description: Update a glossary term
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: governance-glossary-terms.updateglossaryterm
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-glossary-term
      description: Delete a glossary term
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: governance-glossary-terms.deleteglossaryterm
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.