Feat: Documentation for Code Push API - #640
Merged
Merged
Conversation
To make our docs more AI/agent friendly added documentation for Shorebird Code Push API, including authentication methods, resource model, endpoint groups, and common patterns. Includes a direct link to the specification and built with inspiration from: https://vercel.com/docs/rest-api
nickshorebird
requested changes
Sep 2, 2026
nickshorebird
left a comment
nickshorebird
left a comment
Contributor
There was a problem hiding this comment.
LGTM otherwise. Thanks for putting this together.
Updated title and added expiration details for API keys.
nickshorebird
approved these changes
Sep 2, 2026
nickshorebird
left a comment
nickshorebird
left a comment
Contributor
There was a problem hiding this comment.
LGTM - Thanks for the changes.
AbhishekDoshi26
approved these changes
Sep 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
To make our docs more AI/agent friendly added documentation for Shorebird Code Push API, including authentication methods, resource model, endpoint groups, and common patterns.
Includes a direct link to the specification and built with inspiration from: https://vercel.com/docs/rest-api
Status
READY/IN DEVELOPMENT/HOLD
Description
Built a new page with a direct link to our API spec. The page includes some basic information about the spec, the spec should be the source of truth.