Knowi Management API — Dashboards

naftiko: 1.0.0-alpha2
info:
  label: Knowi Management API — Dashboards
  description: 'Knowi Management API — Dashboards. 6 operations. Lead operation: List dashboards. Self-contained Naftiko capability
    covering one Knowi business surface.'
  tags:
  - Knowi
  - Dashboards
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    KNOWI_API_KEY: KNOWI_API_KEY
capability:
  consumes:
  - type: http
    namespace: management-dashboards
    baseUri: https://knowi.com/api/1.0
    description: Knowi Management API — Dashboards business capability. Self-contained, no shared references.
    resources:
    - name: dashboards
      path: /dashboards
      operations:
      - name: listdashboards
        method: GET
        description: List dashboards
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: dashboards-objectId
      path: /dashboards/{objectId}
      operations:
      - name: getdashboard
        method: GET
        description: Get dashboard
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: objectId
          in: path
          type: string
          required: true
    - name: dashboards-objectId-share
      path: /dashboards/{objectId}/share
      operations:
      - name: getdashboardshare
        method: GET
        description: Get dashboard share info
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: objectId
          in: path
          type: string
          required: true
    - name: dashboards-objectId-share-url
      path: /dashboards/{objectId}/share/url
      operations:
      - name: generateshareurl
        method: POST
        description: Generate share URL
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: objectId
          in: path
          type: string
          required: true
    - name: dashboards-objectId-share-url-secure
      path: /dashboards/{objectId}/share/url/secure
      operations:
      - name: generatesecureshareurl
        method: POST
        description: Generate secure share URL
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: objectId
          in: path
          type: string
          required: true
    - name: dashboards-objectId-share-url-secure-hash
      path: /dashboards/{objectId}/share/url/secure/hash
      operations:
      - name: generatesecuresharehash
        method: POST
        description: Generate secure share hash
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: objectId
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.KNOWI_API_KEY}}'
  exposes:
  - type: rest
    namespace: management-dashboards-rest
    port: 8080
    description: REST adapter for Knowi Management API — Dashboards. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/dashboards
      name: dashboards
      description: REST surface for dashboards.
      operations:
      - method: GET
        name: listdashboards
        description: List dashboards
        call: management-dashboards.listdashboards
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/dashboards/{objectid}
      name: dashboards-objectid
      description: REST surface for dashboards-objectId.
      operations:
      - method: GET
        name: getdashboard
        description: Get dashboard
        call: management-dashboards.getdashboard
        with:
          objectId: rest.objectId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/dashboards/{objectid}/share
      name: dashboards-objectid-share
      description: REST surface for dashboards-objectId-share.
      operations:
      - method: GET
        name: getdashboardshare
        description: Get dashboard share info
        call: management-dashboards.getdashboardshare
        with:
          objectId: rest.objectId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/dashboards/{objectid}/share/url
      name: dashboards-objectid-share-url
      description: REST surface for dashboards-objectId-share-url.
      operations:
      - method: POST
        name: generateshareurl
        description: Generate share URL
        call: management-dashboards.generateshareurl
        with:
          objectId: rest.objectId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/dashboards/{objectid}/share/url/secure
      name: dashboards-objectid-share-url-secure
      description: REST surface for dashboards-objectId-share-url-secure.
      operations:
      - method: POST
        name: generatesecureshareurl
        description: Generate secure share URL
        call: management-dashboards.generatesecureshareurl
        with:
          objectId: rest.objectId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/dashboards/{objectid}/share/url/secure/hash
      name: dashboards-objectid-share-url-secure-hash
      description: REST surface for dashboards-objectId-share-url-secure-hash.
      operations:
      - method: POST
        name: generatesecuresharehash
        description: Generate secure share hash
        call: management-dashboards.generatesecuresharehash
        with:
          objectId: rest.objectId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: management-dashboards-mcp
    port: 9090
    transport: http
    description: MCP adapter for Knowi Management API — Dashboards. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-dashboards
      description: List dashboards
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: management-dashboards.listdashboards
      outputParameters:
      - type: object
        mapping: $.
    - name: get-dashboard
      description: Get dashboard
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: management-dashboards.getdashboard
      with:
        objectId: tools.objectId
      outputParameters:
      - type: object
        mapping: $.
    - name: get-dashboard-share-info
      description: Get dashboard share info
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: management-dashboards.getdashboardshare
      with:
        objectId: tools.objectId
      outputParameters:
      - type: object
        mapping: $.
    - name: generate-share-url
      description: Generate share URL
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: management-dashboards.generateshareurl
      with:
        objectId: tools.objectId
      outputParameters:
      - type: object
        mapping: $.
    - name: generate-secure-share-url
      description: Generate secure share URL
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: management-dashboards.generatesecureshareurl
      with:
        objectId: tools.objectId
      outputParameters:
      - type: object
        mapping: $.
    - name: generate-secure-share-hash
      description: Generate secure share hash
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: management-dashboards.generatesecuresharehash
      with:
        objectId: tools.objectId
      outputParameters:
      - type: object
        mapping: $.