Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Commerce Partner Resellers API

11 actions 11 updates phrasing extends openapi/adobe-suite-resellers-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Adobe Suite's API. It is a proposal applied on top of the contract, not a document Adobe Suite publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 11

$.info
$.paths['/v2/resellers'].post
$.paths['/v2/resellers/{account-id}/accept/{approval-code}'].get
$.paths['/v2/resellers/{account-id}/accept/{approval-code}'].post
$.paths['/v2/resellers/{reseller-id}'].get
$.paths['/v2/resellers/{reseller-id}'].patch
$.paths['/v3/resellers'].post
$.paths['/v3/resellers/{account-id}/accept/{approval-code}'].get
$.paths['/v3/resellers/{account-id}/accept/{approval-code}'].post
$.paths['/v3/resellers/{reseller-id}'].get
$.paths['/v3/resellers/{reseller-id}'].patch

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Commerce Partner Resellers API
  version: 1.0.0
extends: openapi/adobe-suite-resellers-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/v2/resellers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a reseller account (v2)
      effect: write
      questions:
      - How do I create a reseller account with the v2 endpoint?
      - What company profile details does v2 reseller creation require?
      instructions:
      - text: Create a v2 reseller account for company profile {profile}.
        slots:
          profile: requestBody.companyProfile
      - text: Using v2, create a reseller under distributor {distributor} with profile {profile}.
        slots:
          distributor: requestBody.distributorId
          profile: requestBody.companyProfile
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/resellers/{account-id}/accept/{approval-code}'].get
  update:
    x-apievangelist-phrasing:
      intent: Preview a reseller change (v2)
      effect: read
      questions:
      - How do I check an approval code before switching a customer's reseller on v2?
      - Which subscriptions move in a v2 reseller change preview?
      instructions:
      - text: Preview the v2 reseller change for account {account} with code {code}.
        slots:
          account: path.account-id
          code: path.approval-code
      - text: Validate approval code {code} for account {account} using v2.
        slots:
          account: path.account-id
          code: path.approval-code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/resellers/{account-id}/accept/{approval-code}'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a reseller change (v2)
      effect: write
      questions:
      - How do I complete a reseller transfer with the v2 API?
      - Once the v2 approval code checks out, how do I apply the change?
      instructions:
      - text: Apply the v2 reseller change for account {account} with code {code}.
        slots:
          account: path.account-id
          code: path.approval-code
      - text: Execute reseller change code {code} on account {account} via v2.
        slots:
          account: path.account-id
          code: path.approval-code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/resellers/{reseller-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a reseller account (v2)
      effect: read
      questions:
      - How do I read a reseller's account details with the v2 API?
      - What company profile info does the v2 reseller lookup return?
      instructions:
      - text: Get v2 reseller account {reseller}.
        slots:
          reseller: path.reseller-id
      - text: Show reseller {reseller}'s profile from the v2 endpoint.
        slots:
          reseller: path.reseller-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/resellers/{reseller-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a reseller account (v2)
      effect: write
      questions:
      - How do I change a reseller's address or phone number on v2?
      - Can I update reseller contacts with the v2 API?
      instructions:
      - text: Update v2 reseller {reseller} with company profile {profile}.
        slots:
          reseller: path.reseller-id
          profile: requestBody.companyProfile
      - text: Using v2, change reseller {reseller}'s profile to {profile}.
        slots:
          reseller: path.reseller-id
          profile: requestBody.companyProfile
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/resellers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a reseller account (v3)
      effect: write
      questions:
      - How do I onboard a reseller on the v3 reseller API after they accept terms?
      - Can I set an external reference ID when creating a v3 reseller?
      instructions:
      - text: Create a v3 reseller account for company profile {profile}.
        slots:
          profile: requestBody.companyProfile
      - text: On v3, create a reseller with profile {profile} and external reference {ref}.
        slots:
          profile: requestBody.companyProfile
          ref: requestBody.externalReferenceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/resellers/{account-id}/accept/{approval-code}'].get
  update:
    x-apievangelist-phrasing:
      intent: Preview a reseller change (v3)
      effect: read
      questions:
      - What subscriptions would transfer in a v3 reseller change?
      - Can I verify a reseller-change approval code with the v3 API first?
      instructions:
      - text: Preview the v3 reseller change for account {account} using code {code}.
        slots:
          account: path.account-id
          code: path.approval-code
      - text: Check approval code {code} on account {account} with the v3 endpoint.
        slots:
          account: path.account-id
          code: path.approval-code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/resellers/{account-id}/accept/{approval-code}'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a reseller change (v3)
      effect: write
      questions:
      - How do I execute a reseller change using the v3 endpoint?
      - Can I finalize moving a customer to a new reseller on v3?
      instructions:
      - text: Apply the v3 reseller change for account {account} with code {code}.
        slots:
          account: path.account-id
          code: path.approval-code
      - text: Execute reseller change code {code} on account {account} via v3.
        slots:
          account: path.account-id
          code: path.approval-code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/resellers/{reseller-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a reseller account (v3)
      effect: read
      questions:
      - How do I fetch a reseller's distributor and contacts on v3?
      - Can I look up a reseller account by ID in the v3 API?
      instructions:
      - text: Get v3 reseller account {reseller}.
        slots:
          reseller: path.reseller-id
      - text: Show reseller {reseller}'s account info from the v3 endpoint.
        slots:
          reseller: path.reseller-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/resellers/{reseller-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a reseller account (v3)
      effect: write
      questions:
      - How do I edit a reseller's company profile on v3?
      - Can I set an external reference on an existing v3 reseller?
      instructions:
      - text: Update v3 reseller {reseller} with company profile {profile}.
        slots:
          reseller: path.reseller-id
          profile: requestBody.companyProfile
      - text: On v3, set external reference {ref} for reseller {reseller} with profile {profile}.
        slots:
          reseller: path.reseller-id
          ref: requestBody.externalReferenceId
          profile: requestBody.companyProfile
      method: generated
      generated: '2026-09-26'