ReadMe API — APIs

naftiko: 1.0.0-alpha2
info:
  label: ReadMe API — APIs
  description: 'ReadMe API — APIs. 4 operations. Lead operation: List API specifications. Self-contained Naftiko capability
    covering one Readme business surface.'
  tags:
  - Readme
  - APIs
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    README_API_KEY: README_API_KEY
capability:
  consumes:
  - type: http
    namespace: readme-apis
    baseUri: https://api.readme.com/v2
    description: ReadMe API — APIs business capability. Self-contained, no shared references.
    resources:
    - name: api-specification
      path: /api-specification
      operations:
      - name: get
        method: GET
        description: List API specifications
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: perPage
          in: query
          type: integer
        - name: page
          in: query
          type: integer
        - name: x-readme-version
          in: header
          type: string
          required: true
      - name: post
        method: POST
        description: Upload an API specification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-specification-id
      path: /api-specification/{id}
      operations:
      - name: put
        method: PUT
        description: Update an API specification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: delete
        method: DELETE
        description: Delete an API specification
        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-apis-rest
    port: 8080
    description: REST adapter for ReadMe API — APIs. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/api-specification
      name: api-specification
      description: REST surface for api-specification.
      operations:
      - method: GET
        name: get
        description: List API specifications
        call: readme-apis.get
        with:
          perPage: rest.perPage
          page: rest.page
          x-readme-version: rest.x-readme-version
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: post
        description: Upload an API specification
        call: readme-apis.post
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api-specification/{id}
      name: api-specification-id
      description: REST surface for api-specification-id.
      operations:
      - method: PUT
        name: put
        description: Update an API specification
        call: readme-apis.put
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: Delete an API specification
        call: readme-apis.delete
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: readme-apis-mcp
    port: 9090
    transport: http
    description: MCP adapter for ReadMe API — APIs. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-api-specifications
      description: List API specifications
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: readme-apis.get
      with:
        perPage: tools.perPage
        page: tools.page
        x-readme-version: tools.x-readme-version
      outputParameters:
      - type: object
        mapping: $.
    - name: upload-api-specification
      description: Upload an API specification
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: readme-apis.post
      outputParameters:
      - type: object
        mapping: $.
    - name: update-api-specification
      description: Update an API specification
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: readme-apis.put
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-api-specification
      description: Delete an API specification
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: readme-apis.delete
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.