Products API — Products

naftiko: 1.0.0-alpha2
info:
  label: Products API — Products
  description: 'Products API — Products. 6 operations. Lead operation: Retrieves Products. Self-contained Naftiko capability
    covering one Products Api business surface.'
  tags:
  - Products Api
  - Products
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PRODUCTS_API_API_KEY: PRODUCTS_API_API_KEY
capability:
  consumes:
  - type: http
    namespace: products-products
    baseUri: https://api.example.com
    description: Products API — Products business capability. Self-contained, no shared references.
    resources:
    - name: products
      path: /products
      operations:
      - name: getproducts
        method: GET
        description: Retrieves Products
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createproduct
        method: POST
        description: Products Create Product
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: products-productId
      path: /products/{productId}
      operations:
      - name: getproduct
        method: GET
        description: Products Retrieve Product
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateproduct
        method: PUT
        description: Products Update Product
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteproduct
        method: DELETE
        description: Products Delete Product
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: products-productId-cancle
      path: /products/{productId}/cancle
      operations:
      - name: sendproduct
        method: PUT
        description: Products Cancel Product
        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.PRODUCTS_API_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: products-products-rest
    port: 8080
    description: REST adapter for Products API — Products. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/products
      name: products
      description: REST surface for products.
      operations:
      - method: GET
        name: getproducts
        description: Retrieves Products
        call: products-products.getproducts
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createproduct
        description: Products Create Product
        call: products-products.createproduct
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/products/{productid}
      name: products-productid
      description: REST surface for products-productId.
      operations:
      - method: GET
        name: getproduct
        description: Products Retrieve Product
        call: products-products.getproduct
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateproduct
        description: Products Update Product
        call: products-products.updateproduct
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteproduct
        description: Products Delete Product
        call: products-products.deleteproduct
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/products/{productid}/cancle
      name: products-productid-cancle
      description: REST surface for products-productId-cancle.
      operations:
      - method: PUT
        name: sendproduct
        description: Products Cancel Product
        call: products-products.sendproduct
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: products-products-mcp
    port: 9090
    transport: http
    description: MCP adapter for Products API — Products. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: retrieves-products
      description: Retrieves Products
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: products-products.getproducts
      outputParameters:
      - type: object
        mapping: $.
    - name: products-create-product
      description: Products Create Product
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: products-products.createproduct
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: products-retrieve-product
      description: Products Retrieve Product
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: products-products.getproduct
      outputParameters:
      - type: object
        mapping: $.
    - name: products-update-product
      description: Products Update Product
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: products-products.updateproduct
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: products-delete-product
      description: Products Delete Product
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: products-products.deleteproduct
      outputParameters:
      - type: object
        mapping: $.
    - name: products-cancel-product
      description: Products Cancel Product
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: products-products.sendproduct
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.