Microsoft Purview Unified Catalog API — OKRs

naftiko: 1.0.0-alpha2
info:
  label: Microsoft Purview Unified Catalog API — OKRs
  description: 'Microsoft Purview Unified Catalog API — OKRs. 2 operations. Lead operation: Microsoft Purview List OKRs. Self-contained
    Naftiko capability covering one Microsoft Purview business surface.'
  tags:
  - Microsoft Purview
  - OKRs
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MICROSOFT_PURVIEW_API_KEY: MICROSOFT_PURVIEW_API_KEY
capability:
  consumes:
  - type: http
    namespace: unified-catalog-okrs
    baseUri: https://{accountName}.purview.azure.com
    description: Microsoft Purview Unified Catalog API — OKRs business capability. Self-contained, no shared references.
    resources:
    - name: okrs
      path: /okrs
      operations:
      - name: listokrs
        method: GET
        description: Microsoft Purview List OKRs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: api-version
          in: query
          type: string
          required: true
        - name: maxpagesize
          in: query
          type: integer
      - name: createokr
        method: POST
        description: Microsoft Purview Create an OKR
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: api-version
          in: query
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.MICROSOFT_PURVIEW_API_KEY}}'
  exposes:
  - type: rest
    namespace: unified-catalog-okrs-rest
    port: 8080
    description: REST adapter for Microsoft Purview Unified Catalog API — OKRs. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/okrs
      name: okrs
      description: REST surface for okrs.
      operations:
      - method: GET
        name: listokrs
        description: Microsoft Purview List OKRs
        call: unified-catalog-okrs.listokrs
        with:
          api-version: rest.api-version
          maxpagesize: rest.maxpagesize
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createokr
        description: Microsoft Purview Create an OKR
        call: unified-catalog-okrs.createokr
        with:
          api-version: rest.api-version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: unified-catalog-okrs-mcp
    port: 9090
    transport: http
    description: MCP adapter for Microsoft Purview Unified Catalog API — OKRs. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: microsoft-purview-list-okrs
      description: Microsoft Purview List OKRs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: unified-catalog-okrs.listokrs
      with:
        api-version: tools.api-version
        maxpagesize: tools.maxpagesize
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-create-okr
      description: Microsoft Purview Create an OKR
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: unified-catalog-okrs.createokr
      with:
        api-version: tools.api-version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.