docs(express): set x-internal: false on 4 operations#8758
Merged
Conversation
07ab3b5 to
e703432
Compare
starfy84
approved these changes
May 13, 2026
Marzooqa
approved these changes
May 14, 2026
Add @public JSDoc tag to the 3 routes that were missing an explicit visibility declaration. The 4th route (GET /api/v2/ping) already had @public. The @public tag generates x-internal: false in the synced express.yaml OpenAPI spec, satisfying the openapi-spec-quality lint rule. Routes updated: - POST /api/v1/wallets/simplecreate - POST /api/v1/walletshare/{shareId}/acceptShare - POST /api/v2/{coin}/verifyaddress Ticket: DX-1065 Session-Id: 2350e389-b3c4-46ab-abd0-4bb17ef1df96 Task-Id: a2a9ad52-5781-4878-856b-c2484c5eb158
e703432 to
5361076
Compare
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
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.
Summary
@publicJSDoc tag to 3 express typed-route files that were missing an explicit visibility declarationGET /api/v2/ping) already had@publicand needed no change@publictag is processed by@api-ts/openapi-generatorto emitx-internal: falsein the syncedcontent/services/express.yamlin dev-portal, satisfying theopenapi-spec-qualitylint ruleOperations updated:
POST /api/v1/wallets/simplecreate(v1/simpleCreate.ts)POST /api/v1/walletshare/{shareId}/acceptShare(v1/acceptShare.ts)POST /api/v2/{coin}/verifyaddress(v2/verifyCoinAddress.ts)No runtime or doc behavior change — omitted
x-internalis already treated as public; this just makes the declaration explicit.Closes: DX-1065
🤖 Generated with Ralph