Persons API — Persons

naftiko: 1.0.0-alpha2
info:
  label: Persons API — Persons
  description: 'Persons API — Persons. 6 operations. Lead operation: Retrieves Persons. Self-contained Naftiko capability
    covering one Persons Api business surface.'
  tags:
  - Persons Api
  - Persons
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PERSONS_API_API_KEY: PERSONS_API_API_KEY
capability:
  consumes:
  - type: http
    namespace: persons-persons
    baseUri: https://api.example.com
    description: Persons API — Persons business capability. Self-contained, no shared references.
    resources:
    - name: persons
      path: /persons
      operations:
      - name: getpersons
        method: GET
        description: Retrieves Persons
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createperson
        method: POST
        description: Persons Create Person
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: persons-personId
      path: /persons/{personId}
      operations:
      - name: getperson
        method: GET
        description: Persons Retrieve Person
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateperson
        method: PUT
        description: Persons Update Person
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteperson
        method: DELETE
        description: Persons Delete Person
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: persons-personId-cancle
      path: /persons/{personId}/cancle
      operations:
      - name: sendperson
        method: PUT
        description: Persons Cancel Person
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: api-key
      value: '{{env.PERSONS_API_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: persons-persons-rest
    port: 8080
    description: REST adapter for Persons API — Persons. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/persons
      name: persons
      description: REST surface for persons.
      operations:
      - method: GET
        name: getpersons
        description: Retrieves Persons
        call: persons-persons.getpersons
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createperson
        description: Persons Create Person
        call: persons-persons.createperson
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/persons/{personid}
      name: persons-personid
      description: REST surface for persons-personId.
      operations:
      - method: GET
        name: getperson
        description: Persons Retrieve Person
        call: persons-persons.getperson
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateperson
        description: Persons Update Person
        call: persons-persons.updateperson
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteperson
        description: Persons Delete Person
        call: persons-persons.deleteperson
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/persons/{personid}/cancle
      name: persons-personid-cancle
      description: REST surface for persons-personId-cancle.
      operations:
      - method: PUT
        name: sendperson
        description: Persons Cancel Person
        call: persons-persons.sendperson
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: persons-persons-mcp
    port: 9090
    transport: http
    description: MCP adapter for Persons API — Persons. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: retrieves-persons
      description: Retrieves Persons
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: persons-persons.getpersons
      outputParameters:
      - type: object
        mapping: $.
    - name: persons-create-person
      description: Persons Create Person
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: persons-persons.createperson
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: persons-retrieve-person
      description: Persons Retrieve Person
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: persons-persons.getperson
      outputParameters:
      - type: object
        mapping: $.
    - name: persons-update-person
      description: Persons Update Person
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: persons-persons.updateperson
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: persons-delete-person
      description: Persons Delete Person
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: persons-persons.deleteperson
      outputParameters:
      - type: object
        mapping: $.
    - name: persons-cancel-person
      description: Persons Cancel Person
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: persons-persons.sendperson
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.