Salla · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Salla Apps OAuth API

4 actions 4 updates phrasing extends openapi/salla-oauth-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Salla's API. It is a proposal applied on top of the contract, not a document Salla publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/oauth2/auth'].get
$.paths['/oauth2/token'].post
$.paths['/oauth2/user/info'].get

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 Salla Apps OAuth API
  version: 1.0.0
extends: openapi/salla-oauth-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/oauth2/auth'].get
  update:
    x-apievangelist-phrasing:
      intent: Ask a merchant to authorize an app
      effect: read
      questions:
      - How does my app request permission to access a merchant's store data?
      - What scopes can I ask a merchant to grant during authorization?
      instructions:
      - text: Start authorization for client {client_id} with response type {response_type}, redirecting to {redirect_uri}.
        slots:
          client_id: query.client_id
          response_type: query.response_type
          redirect_uri: query.redirect_uri
      - text: Send the merchant to the consent screen for client {client_id} asking for scope {scope}, response type {response_type}, redirect {redirect_uri}.
        slots:
          client_id: query.client_id
          scope: query.scope
          response_type: query.response_type
          redirect_uri: query.redirect_uri
      method: generated
      generated: '2026-10-01'
- target: $.paths['/oauth2/token'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange a code or refresh a token
      effect: write
      questions:
      - How do I turn an authorization code into an access token?
      - Can I refresh an expired Salla access token without asking the merchant again?
      instructions:
      - text: Exchange code {code} for an access token using client {client_id}, secret {client_secret}, grant type {grant_type}.
        slots:
          code: requestBody.code
          client_id: requestBody.client_id
          client_secret: requestBody.client_secret
          grant_type: requestBody.grant_type
      - text: Refresh the token with refresh token {refresh_token} for client {client_id}, secret {client_secret}, grant type {grant_type}.
        slots:
          refresh_token: requestBody.refresh_token
          client_id: requestBody.client_id
          client_secret: requestBody.client_secret
          grant_type: requestBody.grant_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/oauth2/user/info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the authenticated merchant's info
      effect: read
      questions:
      - Which merchant and store does my current access token belong to?
      - Can I check who authorized my app?
      instructions:
      - text: Show the merchant info for my current token.
      - text: Get the authenticated merchant's details.
      method: generated
      generated: '2026-10-01'