feat(api): annotate HTTP endpoints with OpenAPI metadata#884
Draft
RhysSullivan wants to merge 1 commit into
Draft
feat(api): annotate HTTP endpoints with OpenAPI metadata#884RhysSullivan wants to merge 1 commit into
RhysSullivan wants to merge 1 commit into
Conversation
Add `OpenApi.annotations({ identifier, summary, description })` to all 62
HttpApiEndpoints across core/api and the source plugins. Operation IDs match the
trace span names (e.g. `sources.list`, `account.me`), so the served OpenAPI spec
and generated SDK gain stable operation IDs + per-endpoint docs. Pure-additive —
no path/schema/behaviour changes.
Verified: typecheck (all 38 packages), lint (0/0), format, api/cloud/plugin tests.
Deploying with
|
| Status | Name | Latest Commit | Updated (UTC) |
|---|---|---|---|
| ✅ Deployment successful! View logs |
executor-cloud | cc16482 | Jun 02 2026, 06:09 PM |
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
executor-marketing | cc16482 | Commit Preview URL Branch Preview URL |
Jun 02 2026, 06:09 PM |
@executor-js/cli
@executor-js/config
@executor-js/execution
@executor-js/sdk
@executor-js/codemode-core
@executor-js/runtime-quickjs
@executor-js/plugin-file-secrets
@executor-js/plugin-graphql
@executor-js/plugin-keychain
@executor-js/plugin-mcp
@executor-js/plugin-onepassword
@executor-js/plugin-openapi
executor
commit: |
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
1 participant
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.
Adds OpenAPI metadata to every endpoint.
OpenApi.annotations({ identifier, summary, description })on all 62 HttpApiEndpoints acrosscore/apiand the source plugins. Operation IDs match the trace span names from the handler sweep (e.g.sources.list,account.me,mcp.probeEndpoint), so the served OpenAPI spec and generated SDK gain stable operation IDs + per-endpoint docs. Pure-additive — no path/schema/behaviour changes.Stacked on #883.
Verified: typecheck (all 38 packages), lint (0/0), format, and
api/cloud/plugin test suites.Draft.