Skip to content

feat: Add public OpenAPI 3.1 spec for Code Push API#3636

Draft
eseidel wants to merge 1 commit intomainfrom
eseidel/openapi-spec
Draft

feat: Add public OpenAPI 3.1 spec for Code Push API#3636
eseidel wants to merge 1 commit intomainfrom
eseidel/openapi-spec

Conversation

@eseidel
Copy link
Copy Markdown
Contributor

@eseidel eseidel commented Mar 4, 2026

Summary

  • Hand-crafted OpenAPI 3.1 spec documenting all public CLI-facing endpoints, schemas, and auth
  • Exploratory effort to understand the experience before investing in code generation from Dart types
  • Spec lives at packages/shorebird_code_push_protocol/openapi.yaml

Not ready for landing — this is for review/discussion only.

What's included

  • 29 API paths covering users, apps, channels, releases, patches, collaborators, organizations, plan, diagnostics, and patch check
  • 45+ schema definitions matching the protocol package's Dart types
  • JWT Bearer and API Key security schemes

Test plan

  • Validates cleanly with npx @redocly/cli lint (0 errors, minor warnings only)

Hand-crafted OpenAPI spec documenting all public CLI-facing endpoints,
request/response schemas, and authentication methods. This is an
exploratory effort before investing in code generation from Dart types.
@eseidel
Copy link
Copy Markdown
Contributor Author

eseidel commented Mar 23, 2026

Part of #3665.

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.

1 participant