Skip to content

docs(UPIIS-57): register UPI Issuance in the API playground#449

Merged
Anindya-Pandey merged 1 commit into
stagingfrom
UPIIS-47-alias-defaults-otp-docs
Jul 20, 2026
Merged

docs(UPIIS-57): register UPI Issuance in the API playground#449
Anindya-Pandey merged 1 commit into
stagingfrom
UPIIS-47-alias-defaults-otp-docs

Conversation

@Anindya-Pandey

Copy link
Copy Markdown

Add the two feeder inputs the playground consumes from this repo, so /payments/upi-issuance resolves there instead of 404ing behind the "Test in API playground" button the docs already render.

  • products.json: add UPI Issuance under Payments.
  • json/payments/upi-issuance/: 14 mock payloads, one per operation, named after the operationId per this folder's README. Bodies are the spec's existing examples. Each carries sim.plaintext in idempotencyKey, which exchanges the call outside the crypto envelope; an envelope body cannot be authored statically. requestBindingToken and verifyOTP add a scenario directive (sim.bind-ok, sim.otp-ok) for the outcomes that depend on an async event the playground cannot fire. Directives are honoured on sandbox deployments only. No credentials are committed: the sandbox plaintext path needs none.
  • upi-issuance.json: operationIds drop the "onboarding#" prefix. '#' is the URL fragment delimiter, so a payload file named after the old form truncates at the '#' and 404s when fetched. Also align three vpa request-body descriptions with the prose pages, which already say the prefix must start with the user's alias rather than their mobile number.

set-alias stays undocumented, so it has no entry here.

Closes UPIIS-57

Add the two feeder inputs the playground consumes from this repo, so
/payments/upi-issuance resolves there instead of 404ing behind the "Test in
API playground" button the docs already render.

- products.json: add UPI Issuance under Payments.
- json/payments/upi-issuance/: 14 mock payloads, one per operation, named after
  the operationId per this folder's README. Bodies are the spec's existing
  examples. Each carries sim.plaintext in idempotencyKey, which exchanges the
  call outside the crypto envelope; an envelope body cannot be authored
  statically. requestBindingToken and verifyOTP add a scenario directive
  (sim.bind-ok, sim.otp-ok) for the outcomes that depend on an async event the
  playground cannot fire. Directives are honoured on sandbox deployments only.
  No credentials are committed: the sandbox plaintext path needs none.
- upi-issuance.json: operationIds drop the "onboarding#" prefix. '#' is the URL
  fragment delimiter, so a payload file named after the old form truncates at
  the '#' and 404s when fetched. Also align three vpa request-body descriptions
  with the prose pages, which already say the prefix must start with the user's
  alias rather than their mobile number.

set-alias stays undocumented, so it has no entry here.

Closes UPIIS-57
@github-actions

Copy link
Copy Markdown

Checklist to merge a PR 🚀

To merge this pull request, please take time to complete the checklist.

What action did you perform?

Review the corresponding checklist items for the action you performed and mark them done.

Edit an existing content (MDX) page

Checklist

  • Review changes using the MDX preview option
  • If the length of content >15000 chars, use the Content preview portal to view changes
  • If a redirect is needed to the existing page, add a key, value pair in redirects.json

Edit an existing API reference page

Checklist


Add a new content (MDX) page

Checklist

  • Create a .mdx file with the path as its name in the content folder
  • Add frontmatter with all the metadata
  • Review the order of items in Sidebar using the Sidebar preview option
  • Review changes using the MDX preview option
  • If the length of content >15000 chars, use the Content preview portal to view changes
  • Created a folder with the same name, if any children were to be added to the page
  • Once all changes are done, update the menu items by using the Menu Items option
  • Add a key, and value pair in redirects.json if you wish to have a redirect to the new page

Add a new API reference page

Checklist

  • Create a .json file with the product path as its name
  • Create an api-reference.mdx file in the respective product folder inside content folder
  • Add frontmatter with all the metadata
  • Review the order of items in Sidebar using the Sidebar preview option
  • Add API reference in JSON format (OpenAPI or Swagger) into created .json file.
  • Used the Content preview portal to view changes
  • Once all changes are done, update the menu items by using the Menu Items option

@Anindya-Pandey
Anindya-Pandey merged commit 2d04126 into staging Jul 20, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants