Import Corporate Action, Reports, Broker Management APIs (new domains) - #48
Open
hogan-yuan wants to merge 8 commits into
Open
Import Corporate Action, Reports, Broker Management APIs (new domains)#48hogan-yuan wants to merge 8 commits into
hogan-yuan wants to merge 8 commits into
Conversation
Add three new Broker API domains, imported from whale-openapi-docs via the whale-api-import workflow (frontend-verified operation sets): - corporate-action (78 base ops + 23 paired downloads): announcement lifecycle, register/detail, execution, refund by sub-position view, shareholder voting, post-event adjustment, fee management, US option corp action, notify, CCASS, and their datasets. - reports (34 base ops): report list/bookmark, batch printing, export-task, export log, CRS file generation, commission reports, and their datasets. - broker-management (18 base ops): broker relationship import, team & broker, commission-sharing (DCP) setups, user create/lock, and their datasets. Internal-only (x-lbonly: true) operations are excluded: in-transit-funds datasets/retry, WTT client-detail dataset, CRS declaration file, SFTP/export retry. Datasets keep POST as the documented primary with x-post-fallback and folded /download pairing. Wired into src/nimbus/lib/openapi.ts and nested in docs.json navigation for all three locales. `bun run check` passes (0 errors).
…n + 4 datasets Sync the domain with the refined source scope: - Exclude POST /v1/client_fee/import (now x-lbonly: true). - Add POST /v1/option/reconciliation/list and datasets instrument_option_change_details, corp_action_scrip_fee, corp_action_gst_fee, corp_action_post_adjust_detail_announcements (each with paired /download). - post_adjust confirm/delete/revoke/update remain public (kept). Now 109 operations per locale; docs.json nav updated for all three locales. bun run check passes (0 errors).
Deploying whale-docs with
|
| Latest commit: |
939cb95
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://a87c2559.whale-docs.pages.dev |
| Branch Preview URL: | https://feat-import-corp-action-repo.whale-docs.pages.dev |
Import 10 shared-components operations into the Misc domain (all locales):
- Flow Tickets (9): approve step, create/delete comment, export tickets, get step
comments, ticket list v2, handle ticket, update payload, update policies.
- Dataset Download (1): DELETE /v1/datasets/download/{id} (added as delete: on the
existing GET path).
Match the existing get_flow_tickets_with_biz style (tags [Misc], x-verified: verified,
x-mint, standard envelope). Also mark the pre-existing download_records and
get_dataset_download x-verified: verified. docs.json: new Flow Tickets subgroup +
DELETE added to Dataset Export, under Misc, all three locales. bun run check passes.
…u.json Reorder the three new-domain nav groups (and their nested subgroups) to follow menu.json. Sorting is anchored on each entry's operation path (locale-independent) rather than the display label, so zh-HK subgroups sort correctly despite menu.json's zh-HK labels differing in wording from the bundle's Traditional labels (e.g. 匯出日誌 vs 導出日誌).
Every operation under Broker Management is non-WhaleAPI and has been marked
x-lbonly: true in the source, so it is not for public docs. Remove the domain:
delete broker-management.{en,zh-CN,zh-HK}.yml, unregister it in openapi.ts
(imports, parse consts, mergeDocuments args, domainDocuments), and drop the
Broker Management nav group from docs.json for all three locales.
bun run check passes.
Sync the source change: 查询该租户企业行动是否需要工单审批 -> 查询该企业行动是否需要工单审批.
…on-report-broker-crs # Conflicts: # src/nimbus/lib/openapi.ts
Remove the Reports domain from this PR so it can land through the Day-End Mgr PR
instead: delete reports.{en,zh-CN,zh-HK}.yml, unregister in openapi.ts, and drop
the Reports nav group from docs.json (all locales). This PR now covers
Corporate Action only.
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.
Summary
Adds three new Broker API domains, imported from
whale-openapi-docsvia thewhale-api-importworkflow. Operation sets were determined by tracing the actual frontend feature pages infe-wealth-admin(not the raw gateway route list), and each operation/template was verified to be really invoked./download; announcement lifecycle, register/detail, execution, refund-by-sub-position-view, shareholder voting, post-event adjustment, fee management, US option corp action, notify, CCASSDetails
x-lbonly: true): in-transit-funds datasets + retry, WTT client-detail dataset, CRS declaration-file generation, SFTP/export retry.POSTas the documented primary withx-post-fallback: true; each/downloadis folded under its base op (x-dataset-download/x-dataset-parent) and kept out of navigation.broker-api/<domain>.{en,zh-CN,zh-HK}.yml), wired intosrc/nimbus/lib/openapi.ts, and nested intodocs.jsonnavigation for all three locales per each op's source menu path.bun run checkpasses: 0 errors, heading anchors aligned.