VTex Subscriptions API (v3) — Settings

naftiko: 1.0.0-alpha2
info:
  label: VTex Subscriptions API (v3) — Settings
  description: 'VTex Subscriptions API (v3) — Settings. 2 operations. Lead operation: VTex Get Subscription Settings. Self-contained
    Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Settings
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: subscriptions-settings
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Subscriptions API (v3) — Settings business capability. Self-contained, no shared references.
    resources:
    - name: api-rns-settings
      path: /api/rns/settings
      operations:
      - name: getsettings
        method: GET
        description: VTex Get Subscription Settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Content-Type
          in: header
          type: string
          description: Type of the content being sent.
          required: true
        - name: Accept
          in: header
          type: string
          description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
          required: true
      - name: editsettings
        method: POST
        description: VTex Edit Subscriptions settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Content-Type
          in: header
          type: string
          description: Type of the content being sent.
          required: true
        - name: Accept
          in: header
          type: string
          description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
          required: true
        - 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: subscriptions-settings-rest
    port: 8080
    description: REST adapter for VTex Subscriptions API (v3) — Settings. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/rns/settings
      name: api-rns-settings
      description: REST surface for api-rns-settings.
      operations:
      - method: GET
        name: getsettings
        description: VTex Get Subscription Settings
        call: subscriptions-settings.getsettings
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: editsettings
        description: VTex Edit Subscriptions settings
        call: subscriptions-settings.editsettings
        with:
          Content-Type: rest.Content-Type
          Accept: rest.Accept
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: subscriptions-settings-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Subscriptions API (v3) — Settings. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: vtex-get-subscription-settings
      description: VTex Get Subscription Settings
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: subscriptions-settings.getsettings
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-edit-subscriptions-settings
      description: VTex Edit Subscriptions settings
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: subscriptions-settings.editsettings
      with:
        Content-Type: tools.Content-Type
        Accept: tools.Accept
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.