docs(api): expose tags on account and operation responses#17
Merged
marioalvial merged 5 commits intomainfrom May 4, 2026
Merged
docs(api): expose tags on account and operation responses#17marioalvial merged 5 commits intomainfrom
marioalvial merged 5 commits intomainfrom
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Backfills the tags array (previously missing) in the pixWithdrawal, brlToUsdSwap, and pixDeposit named examples so the rendered response panel matches the OperationResponse schema, which already lists tags as required.
leoneparise
approved these changes
May 4, 2026
Mirrors the AccountResponse/OperationResponse pattern. Introduces TagEvent in fx-webhook to keep the *Event suffix convention. Documented ahead of the Kotlin OperationEvent class, which will need a matching field on the wire.
Tags is optional on OperationResponse and OperationEvent — the live OperationApiResponse and OperationEvent Kotlin classes don't yet carry the field, so leaving required would force strict consumers to fail against today's wire payloads. AccountResponse keeps tags required since the live AccountResponse Kotlin class already exposes it. Trims the Filters parameter override on /api/reports to drop the LHS Brackets preamble already covered by the shared Filters description, leaving only the report-specific examples and a pointer to the Filtering guide.
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
2 participants
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.
Description
Documents the
tagsfield on account and operation API responses. Tags are system-managed labels assigned by Trace based on routing, compliance, and operational criteria; clients cannot create, modify, or remove them via the API.The wire shape is an array of objects with a nullable
keyand a requiredvalue, matching the liveTagResponseinfx-account. Single-value labels (e.g.,hidden) carrykey: null; keyed tags (e.g.,psp=Amazon,compliance-tier=high) populate both fields.Account-side tags are already live in
fx-account. Operation-side tags are aspirational — they ship in the spec ahead offx-paymentimplementation per the project's aspirational-docs pattern.Key Changes
TagResponseschema inapis/fx-account/openapi.ymlwith description, per-property descriptions, and realistic examples.AccountResponse.tags.TagResponseintoapis/fx-payment/openapi.yml.tagsfield toOperationResponsewith description noting inheritance from the account.Type of change
How Has This Been Tested?
Validated locally with
mint validate(passes) andmint broken-links(passes).Checklist:
Backend follow-up
fx-paymentneeds to catch up to the documented contract:Tagshared domain (or import fromfx-account)tags: List<Tag>onOperationandOperationApiResponse