VTex Legacy CMS Portal API — Change URI Schema

naftiko: 1.0.0-alpha2
info:
  label: VTex Legacy CMS Portal API — Change URI Schema
  description: 'VTex Legacy CMS Portal API — Change URI Schema. 2 operations. Lead operation: VTex Update all account''s websites
    internet communication protocol. Self-contained Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Change URI Schema
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: legacy-cms-portal-change-uri-schema
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Legacy CMS Portal API — Change URI Schema business capability. Self-contained, no shared references.
    resources:
    - name: api-catalog_system-pvt-virtualfolder-changeurischema-protocol
      path: /api/catalog_system/pvt/virtualfolder/changeurischema/{protocol}
      operations:
      - name: changeentireaccountallwebsites
        method: PUT
        description: VTex Update all account's websites internet communication protocol
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: protocol
          in: path
          type: string
          description: Internet communication protocol, it can be `HTTP` or `HTTPS`.
          required: true
    - name: api-catalog_system-pvt-virtualfolder-site-websiteId-changeurischema-protocol
      path: /api/catalog_system/pvt/virtualfolder/site/{websiteId}/changeurischema/{protocol}
      operations:
      - name: changespecificwebsite
        method: PUT
        description: VTex Update specific website comunication protocol
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: websiteId
          in: path
          type: string
          description: Specific website ID.
          required: true
        - name: protocol
          in: path
          type: string
          description: Internet communication protocol, it can be `HTTP` or `HTTPS`.
          required: true
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: legacy-cms-portal-change-uri-schema-rest
    port: 8080
    description: REST adapter for VTex Legacy CMS Portal API — Change URI Schema. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/api/catalog-system/pvt/virtualfolder/changeurischema/{protocol}
      name: api-catalog-system-pvt-virtualfolder-changeurischema-protocol
      description: REST surface for api-catalog_system-pvt-virtualfolder-changeurischema-protocol.
      operations:
      - method: PUT
        name: changeentireaccountallwebsites
        description: VTex Update all account's websites internet communication protocol
        call: legacy-cms-portal-change-uri-schema.changeentireaccountallwebsites
        with:
          protocol: rest.protocol
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog-system/pvt/virtualfolder/site/{websiteid}/changeurischema/{protocol}
      name: api-catalog-system-pvt-virtualfolder-site-websiteid-changeurischema-protocol
      description: REST surface for api-catalog_system-pvt-virtualfolder-site-websiteId-changeurischema-protocol.
      operations:
      - method: PUT
        name: changespecificwebsite
        description: VTex Update specific website comunication protocol
        call: legacy-cms-portal-change-uri-schema.changespecificwebsite
        with:
          websiteId: rest.websiteId
          protocol: rest.protocol
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: legacy-cms-portal-change-uri-schema-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Legacy CMS Portal API — Change URI Schema. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: vtex-update-all-account-s-websites
      description: VTex Update all account's websites internet communication protocol
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: legacy-cms-portal-change-uri-schema.changeentireaccountallwebsites
      with:
        protocol: tools.protocol
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-update-specific-website-comunication
      description: VTex Update specific website comunication protocol
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: legacy-cms-portal-change-uri-schema.changespecificwebsite
      with:
        websiteId: tools.websiteId
        protocol: tools.protocol
      outputParameters:
      - type: object
        mapping: $.