Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Clarify Admin REST Docs #504

Merged
merged 1 commit into from
Dec 1, 2023
Merged

Conversation

lizkenyon
Copy link
Contributor

WHAT is this pull request doing?

  • Improve Admin REST docs based on developer feedback

  • Point developers to the Admin REST references docs, to see specific example there using the REST resources

  • Move the app.routes file example with the relevant code to be shown in the first tab and the supporting code in shopify.server to the second tab

  • Add a POST request example. Because we are not pulling in the types from Shopify-api-js currently, it is not easy to determine the params.

  • Also forgot to run yarn build-docs yesterday to webhook updates are included here. 🙈

Type of change

  • Patch: Bug (non-breaking change which fixes an issue)
  • Minor: New feature (non-breaking change which adds functionality)
  • Major: Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

  • I have used yarn changeset to create a draft changelog entry (do NOT update the CHANGELOG.md files manually)
  • I have added/updated tests for this change
  • I have documented new APIs/updated the documentation for modified APIs (for public APIs)

@lizkenyon lizkenyon requested a review from a team as a code owner November 30, 2023 17:23
@lizkenyon lizkenyon force-pushed the liz/clarify-admin-rest-docs branch from 04b7d3a to c1f8b0a Compare November 30, 2023 17:25
@lizkenyon lizkenyon merged commit 2c489de into main Dec 1, 2023
10 checks passed
@lizkenyon lizkenyon deleted the liz/clarify-admin-rest-docs branch December 1, 2023 15:04
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