ReadMe API — API Keys

naftiko: 1.0.0-alpha2
info:
  label: ReadMe API — API Keys
  description: 'ReadMe API — API Keys. 3 operations. Lead operation: List API keys. Self-contained Naftiko capability covering
    one Readme business surface.'
  tags:
  - Readme
  - API Keys
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    README_API_KEY: README_API_KEY
capability:
  consumes:
  - type: http
    namespace: readme-api-keys
    baseUri: https://api.readme.com/v2
    description: ReadMe API — API Keys business capability. Self-contained, no shared references.
    resources:
    - name: apikeys
      path: /apikeys
      operations:
      - name: get
        method: GET
        description: List API keys
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post
        method: POST
        description: Create an API key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: apikeys-id
      path: /apikeys/{id}
      operations:
      - name: delete
        method: DELETE
        description: Delete an API key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.README_API_KEY}}'
  exposes:
  - type: rest
    namespace: readme-api-keys-rest
    port: 8080
    description: REST adapter for ReadMe API — API Keys. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/apikeys
      name: apikeys
      description: REST surface for apikeys.
      operations:
      - method: GET
        name: get
        description: List API keys
        call: readme-api-keys.get
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: post
        description: Create an API key
        call: readme-api-keys.post
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/apikeys/{id}
      name: apikeys-id
      description: REST surface for apikeys-id.
      operations:
      - method: DELETE
        name: delete
        description: Delete an API key
        call: readme-api-keys.delete
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: readme-api-keys-mcp
    port: 9090
    transport: http
    description: MCP adapter for ReadMe API — API Keys. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-api-keys
      description: List API keys
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: readme-api-keys.get
      outputParameters:
      - type: object
        mapping: $.
    - name: create-api-key
      description: Create an API key
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: readme-api-keys.post
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-api-key
      description: Delete an API key
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: readme-api-keys.delete
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.