VTex Catalog API — Specification

naftiko: 1.0.0-alpha2
info:
  label: VTex Catalog API — Specification
  description: 'VTex Catalog API — Specification. 3 operations. Lead operation: VTex Create specification. Self-contained
    Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Specification
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: catalog-specification
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Catalog API — Specification business capability. Self-contained, no shared references.
    resources:
    - name: api-catalog-pvt-specification
      path: /api/catalog/pvt/specification
      operations:
      - name: post
        method: POST
        description: VTex Create specification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-catalog-pvt-specification-specificationId
      path: /api/catalog/pvt/specification/{specificationId}
      operations:
      - name: get
        method: GET
        description: VTex Get specification by specification ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: specificationId
          in: path
          type: integer
          description: Specification's unique numerical identifier.
          required: true
      - name: put
        method: PUT
        description: VTex Update specification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: specificationId
          in: path
          type: integer
          description: Specification's unique numerical identifier.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: catalog-specification-rest
    port: 8080
    description: REST adapter for VTex Catalog API — Specification. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/catalog/pvt/specification
      name: api-catalog-pvt-specification
      description: REST surface for api-catalog-pvt-specification.
      operations:
      - method: POST
        name: post
        description: VTex Create specification
        call: catalog-specification.post
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog/pvt/specification/{specificationid}
      name: api-catalog-pvt-specification-specificationid
      description: REST surface for api-catalog-pvt-specification-specificationId.
      operations:
      - method: GET
        name: get
        description: VTex Get specification by specification ID
        call: catalog-specification.get
        with:
          specificationId: rest.specificationId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: put
        description: VTex Update specification
        call: catalog-specification.put
        with:
          specificationId: rest.specificationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: catalog-specification-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Catalog API — Specification. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: vtex-create-specification
      description: VTex Create specification
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: catalog-specification.post
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-specification-specification-id
      description: VTex Get specification by specification ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-specification.get
      with:
        specificationId: tools.specificationId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-update-specification
      description: VTex Update specification
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: catalog-specification.put
      with:
        specificationId: tools.specificationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.