ReadMe API — Branches

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