Skip to content

Conversation

@meker12
Copy link
Contributor

@meker12 meker12 commented Aug 21, 2025

Purpose of this pull request

  • Add test the API topic to document the Get Credentials and Try It feature
  • Clarify references to "Instance Id" and "tenant ID"
  • Standardize placeholder references

Staging Preview

Update endpoint template with region and environment parameters.
@meker12 meker12 requested a review from jeff-matthews August 21, 2025 20:53
@github-project-automation github-project-automation bot moved this to 📋 Needs Review in Commerce - Pull Requests Aug 21, 2025
@meker12 meker12 marked this pull request as ready for review August 21, 2025 21:00
Copy link
Contributor

@jeff-matthews jeff-matthews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few challenges here related to the Try it feature:

  1. We assured PM/ENG that we would only support sandbox environments in the Try it feature.
  2. Sandbox environments are only available in the na1 region at the moment (not sure if or when that will change).
  3. Is there an efficient and practical way to restrict the Try it experience to sandbox environments (i.e., overlays)?

If the answer to 3 is no, then we may need to describe the regions and environments outside of the server object.

- Standardize placceholder formats
- Cleanup use of "instance ID" and "tenant ID"
- Cleanup authentication topic, add link to Get
credentials UI in the API reference
- Add GraphQLdata type reference topic (not yet included in the API reference)
- Add placeholder style guide (experimental, not in docs)
@meker12 meker12 requested a review from jeff-matthews August 27, 2025 21:07
@meker12
Copy link
Contributor Author

meker12 commented Aug 27, 2025

A few challenges here related to the Try it feature:

  1. We assured PM/ENG that we would only support sandbox environments in the Try it feature.
  2. Sandbox environments are only available in the na1 region at the moment (not sure if or when that will change).
  3. Is there an efficient and practical way to restrict the Try it experience to sandbox environments (i.e., overlays)?

If the answer to 3 is no, then we may need to describe the regions and environments outside of the server object.

I just left the server schema the same since we only support sandbox instances.

@jeff-matthews jeff-matthews added the major-update Significant original updates to existing content label Aug 28, 2025
@meker12 meker12 requested a review from jeff-matthews August 28, 2025 21:09
Make your first request section.
@github-project-automation github-project-automation bot moved this from 📋 Needs Review to 👍 Approved in Commerce - Pull Requests Aug 29, 2025
@meker12 meker12 merged commit 53857bc into main Aug 29, 2025
6 checks passed
@meker12 meker12 deleted the update-endpoint-template branch August 29, 2025 03:40
@github-project-automation github-project-automation bot moved this from 👍 Approved to 🏁 Done in Commerce - Pull Requests Aug 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

major-update Significant original updates to existing content

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

3 participants