Create fb-provider-off-exchange-api.yaml #196
Open
Conversation
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
Scaffold, awaiting further content
yanivmo
requested changes
Nov 12, 2025
| @@ -0,0 +1,28 @@ | |||
| openapi: 3.0.0 | |||
| info: | |||
| title: 'Fireblocks Provider Off-Exchange API' | |||
Collaborator
There was a problem hiding this comment.
We call an API a provider API, if it's something that a provider implements. In other cases it's just an API. Also we try to stick to the term "collateral" here, to avoid ambiguity. So, these things need to be changed:
- The filename should be
fb-collateral-api.yaml. - The title should be "Fireblocks Collateral API".
- Add
info.descriptionkey and explain there that this is an API implemented by Fireblocks as opposed to the other APIs here.
Comment on lines
+9
to
+10
| - name: collateralWebhooks | ||
| description: Webhook notifications sent by Fireblocks to exchanges for collateral events. |
Collaborator
There was a problem hiding this comment.
The webhooks implemented by providers should be specified in fb-provider-collateral-api.yaml. The endpoints could be under the usual collateral tag, or if you prefer collateralNotifications, or collateralWebhooks. It's only one endpoint and I wouldn't bother with a separate tag, personally.
Comment on lines
+7
to
+8
| - name: offExchange | ||
| description: Endpoints used by external providers (exchanges) calling Fireblocks for off-exchange collateral flows. |
Collaborator
There was a problem hiding this comment.
The name should be collateral.
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.
Scaffold, awaiting further content.