VTex Catalog API — Attachment

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