diff --git a/v2/openapi/fb-collateral-api.yaml b/v2/openapi/fb-collateral-api.yaml new file mode 100644 index 00000000..823e0318 --- /dev/null +++ b/v2/openapi/fb-collateral-api.yaml @@ -0,0 +1,31 @@ +openapi: 3.0.0 +info: + title: 'Fireblocks Collateral API' + description: > + This API is implemented by Fireblocks and provides collateral-related + endpoints for off-exchange workflows. Unlike the provider APIs in this + project, which are implemented by external providers, this API is served + by Fireblocks and defines the endpoints providers interact with. + version: 0.0.1 + +tags: + - name: collateral + description: Endpoints used by external providers (exchanges) calling Fireblocks for off-exchange collateral flows. + +x-path-params: + EntityIdPathParam: { $ref: './fb-provider-api.yaml#/components/parameters/EntityIdPathParam' } + SubAccountIdPathParam: { $ref: './fb-provider-api.yaml#/components/parameters/SubAccountIdPathParam' } + +x-header-params: + X-FBAPI-KEY: { $ref: './fb-provider-api.yaml#/components/parameters/X-FBAPI-KEY' } + X-FBAPI-SIGNATURE: { $ref: './fb-provider-api.yaml#/components/parameters/X-FBAPI-SIGNATURE' } + X-FBAPI-NONCE: { $ref: './fb-provider-api.yaml#/components/parameters/X-FBAPI-NONCE' } + X-FBAPI-TIMESTAMP: { $ref: './fb-provider-api.yaml#/components/parameters/X-FBAPI-TIMESTAMP' } + +x-responses: + BadRequestResponse: { $ref: './fb-provider-api.yaml#/components/responses/BadRequestResponse' } + UnauthorizedResponse: { $ref: './fb-provider-api.yaml#/components/responses/UnauthorizedResponse' } + ErrorResponse: { $ref: './fb-provider-api.yaml#/components/responses/ErrorResponse' } + +paths: {} +components: {}