VTex Catalog API — Specification Field

naftiko: 1.0.0-alpha2
info:
  label: VTex Catalog API — Specification Field
  description: 'VTex Catalog API — Specification Field. 3 operations. Lead operation: VTex Get specification field. Self-contained
    Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Specification Field
  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-field
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Catalog API — Specification Field business capability. Self-contained, no shared references.
    resources:
    - name: api-catalog_system-pub-specification-fieldGet-fieldId
      path: /api/catalog_system/pub/specification/fieldGet/{fieldId}
      operations:
      - name: specificationsfield
        method: GET
        description: VTex Get specification field
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fieldId
          in: path
          type: integer
          description: Specification field ID.
          required: true
    - name: api-catalog_system-pvt-specification-field
      path: /api/catalog_system/pvt/specification/field
      operations:
      - name: specificationsinsertfield
        method: POST
        description: VTex Create specification field
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: specificationsinsertfieldupdate
        method: PUT
        description: VTex Update specification field
        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: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: catalog-specification-field-rest
    port: 8080
    description: REST adapter for VTex Catalog API — Specification Field. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/catalog-system/pub/specification/fieldget/{fieldid}
      name: api-catalog-system-pub-specification-fieldget-fieldid
      description: REST surface for api-catalog_system-pub-specification-fieldGet-fieldId.
      operations:
      - method: GET
        name: specificationsfield
        description: VTex Get specification field
        call: catalog-specification-field.specificationsfield
        with:
          fieldId: rest.fieldId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog-system/pvt/specification/field
      name: api-catalog-system-pvt-specification-field
      description: REST surface for api-catalog_system-pvt-specification-field.
      operations:
      - method: POST
        name: specificationsinsertfield
        description: VTex Create specification field
        call: catalog-specification-field.specificationsinsertfield
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: specificationsinsertfieldupdate
        description: VTex Update specification field
        call: catalog-specification-field.specificationsinsertfieldupdate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: catalog-specification-field-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Catalog API — Specification Field. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: vtex-get-specification-field
      description: VTex Get specification field
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-specification-field.specificationsfield
      with:
        fieldId: tools.fieldId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-create-specification-field
      description: VTex Create specification field
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: catalog-specification-field.specificationsinsertfield
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-update-specification-field
      description: VTex Update specification field
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: catalog-specification-field.specificationsinsertfieldupdate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.