Skip to content

docs(express): set x-internal: false on 4 operations#8758

Merged
starfy84 merged 1 commit into
masterfrom
dx-1065-express-x-internal-false
May 14, 2026
Merged

docs(express): set x-internal: false on 4 operations#8758
starfy84 merged 1 commit into
masterfrom
dx-1065-express-x-internal-false

Conversation

@bitgo-ai-agent-dev
Copy link
Copy Markdown

@bitgo-ai-agent-dev bitgo-ai-agent-dev Bot commented May 12, 2026

Summary

  • Adds @public JSDoc tag to 3 express typed-route files that were missing an explicit visibility declaration
  • The 4th operation (GET /api/v2/ping) already had @public and needed no change
  • The @public tag is processed by @api-ts/openapi-generator to emit x-internal: false in the synced content/services/express.yaml in dev-portal, satisfying the openapi-spec-quality lint rule

Operations 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-internal is already treated as public; this just makes the declaration explicit.

Closes: DX-1065

🤖 Generated with Ralph

@linear-code
Copy link
Copy Markdown

linear-code Bot commented May 12, 2026

DX-1065

@bitgo-ai-agent-dev bitgo-ai-agent-dev Bot force-pushed the dx-1065-express-x-internal-false branch from 07ab3b5 to e703432 Compare May 12, 2026 21:12
@starfy84 starfy84 marked this pull request as ready for review May 13, 2026 14:11
@starfy84 starfy84 requested review from a team as code owners May 13, 2026 14:11
@starfy84 starfy84 requested review from Marzooqa and mrdanish26 May 13, 2026 14:11
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
@starfy84 starfy84 force-pushed the dx-1065-express-x-internal-false branch from e703432 to 5361076 Compare May 14, 2026 13:53
@starfy84 starfy84 merged commit 6d21987 into master May 14, 2026
22 checks passed
@starfy84 starfy84 deleted the dx-1065-express-x-internal-false branch May 14, 2026 14:25
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