From 3e5f58761ad1b8a07f3d66a8f414b51ba3678250 Mon Sep 17 00:00:00 2001 From: "dev-portal-updater[bot]" <149019135+dev-portal-updater[bot]@users.noreply.github.com> Date: Fri, 14 Feb 2025 19:38:30 +0000 Subject: [PATCH] feat: update `bitgo-api-docs` This commit updates the BitGo API. --- api.yaml | 390 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 255 insertions(+), 135 deletions(-) diff --git a/api.yaml b/api.yaml index 9e31011..eae150e 100644 --- a/api.yaml +++ b/api.yaml @@ -1337,100 +1337,6 @@ paths: schema: $ref: '#/components/schemas/PlatformError' /api/address-book/v1/connections: - post: - summary: Add Go Account connection - description: |- - Add a connection for your Go Account to another Go Account. - To connect to a Go Account that's not listed in the public directory, pass a 'walletId'. - To connect to a Go Account that is listed in the public directory, pass a value for the 'targetListingEntryId'. - operationId: V1PostConnectionRoute - tags: - - Counterparties - parameters: [] - requestBody: - content: - application/json: - schema: - oneOf: - - type: object - properties: - listingEntryId: - type: string - title: uuid - localListingEntryDescription: - type: string - minLength: 1 - targetListingEntryId: - type: string - title: uuid - required: - - listingEntryId - - targetListingEntryId - - type: object - properties: - listingEntryId: - type: string - title: uuid - localListingDescription: - type: string - minLength: 1 - localListingEntryDescription: - type: string - minLength: 1 - localListingName: - type: string - minLength: 1 - walletId: - type: string - minLength: 1 - required: - - listingEntryId - - localListingName - - walletId - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/V1ConnectionWithOwnerAndTargetListResponse' - '400': - description: Bad Request - content: - application/json: - schema: - type: object - properties: {} - '401': - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/V1ErrorResponse' - '404': - description: Not Found - content: - application/json: - schema: - $ref: '#/components/schemas/V1ErrorResponse' - '409': - description: Conflict - content: - application/json: - schema: - $ref: '#/components/schemas/V1ErrorResponse' - '422': - description: Unprocessable Entity - content: - application/json: - schema: - $ref: '#/components/schemas/V1ErrorResponse' - '500': - description: Internal Server Error - content: - application/json: - schema: - $ref: '#/components/schemas/V1ErrorResponse' get: summary: List Go Account connections description: Lists connections from your Go Account to other Go Accounts. @@ -1522,6 +1428,94 @@ paths: items: type: string minLength: 1 + - name: enterprise-id + in: header + required: true + schema: + type: string + minLength: 1 + - name: user-id + in: header + required: true + schema: + type: string + minLength: 1 + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/V1ConnectionWithOwnerAndTargetListResponse' + '400': + description: Bad Request + content: + application/json: + schema: + type: object + properties: {} + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/V1ErrorResponse' + '500': + description: Internal Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/V1ErrorResponse' + post: + summary: Add Go Account connection + description: |- + Add a connection for your Go Account to another Go Account. + To connect to a Go Account that's not listed in the public directory, pass a 'walletId'. + To connect to a Go Account that is listed in the public directory, pass a value for the 'targetListingEntryId'. + operationId: V1PostConnectionRoute + tags: + - Counterparties + parameters: [] + requestBody: + content: + application/json: + schema: + oneOf: + - type: object + properties: + listingEntryId: + type: string + title: uuid + localListingEntryDescription: + type: string + minLength: 1 + targetListingEntryId: + type: string + title: uuid + required: + - listingEntryId + - targetListingEntryId + - type: object + properties: + listingEntryId: + type: string + title: uuid + localListingDescription: + type: string + minLength: 1 + localListingEntryDescription: + type: string + minLength: 1 + localListingName: + type: string + minLength: 1 + walletId: + type: string + minLength: 1 + required: + - listingEntryId + - localListingName + - walletId responses: '200': description: OK @@ -1542,6 +1536,24 @@ paths: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/V1ErrorResponse' + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/V1ErrorResponse' + '422': + description: Unprocessable Entity + content: + application/json: + schema: + $ref: '#/components/schemas/V1ErrorResponse' '500': description: Internal Server Error content: @@ -1554,7 +1566,19 @@ paths: operationId: V1PutConnectionsRoute tags: - Counterparties - parameters: [] + parameters: + - name: enterprise-id + in: header + required: true + schema: + type: string + minLength: 1 + - name: user-id + in: header + required: true + schema: + type: string + minLength: 1 requestBody: content: application/json: @@ -1678,6 +1702,18 @@ paths: items: type: string minLength: 1 + - name: enterprise-id + in: header + required: true + schema: + type: string + minLength: 1 + - name: user-id + in: header + required: true + schema: + type: string + minLength: 1 responses: '200': description: OK @@ -1728,6 +1764,18 @@ paths: schema: type: string title: uuid + - name: enterprise-id + in: header + required: true + schema: + type: string + minLength: 1 + - name: user-id + in: header + required: true + schema: + type: string + minLength: 1 requestBody: content: application/json: @@ -1794,6 +1842,18 @@ paths: schema: type: string title: uuid + - name: enterprise-id + in: header + required: true + schema: + type: string + minLength: 1 + - name: user-id + in: header + required: true + schema: + type: string + minLength: 1 requestBody: content: application/json: @@ -1916,6 +1976,18 @@ paths: schema: type: string minLength: 1 + - name: enterprise-id + in: header + required: true + schema: + type: string + minLength: 1 + - name: user-id + in: header + required: true + schema: + type: string + minLength: 1 responses: '200': description: OK @@ -2025,6 +2097,18 @@ paths: schema: type: string minLength: 1 + - name: enterprise-id + in: header + required: true + schema: + type: string + minLength: 1 + - name: user-id + in: header + required: true + schema: + type: string + minLength: 1 responses: '200': description: OK @@ -2058,7 +2142,19 @@ paths: operationId: V1PostListingEntryRoute tags: - Counterparties - parameters: [] + parameters: + - name: enterprise-id + in: header + required: true + schema: + type: string + minLength: 1 + - name: user-id + in: header + required: true + schema: + type: string + minLength: 1 requestBody: content: application/json: @@ -2115,31 +2211,32 @@ paths: schema: $ref: '#/components/schemas/V1ErrorResponse' /api/address-book/v1/listing/global: - post: - summary: Create enterprise listing - description: |- - Create a listing for your enterprise in the Go network. - Once you create a listing for your enterprise, you can list your Go Account in the public directory. - operationId: V1PostListingRoute + get: + summary: Get enterprise listing + description: Get the enterprise listing and list all entries in the enterprise listing. + operationId: V1GetListingRoute tags: - Counterparties - parameters: [] - requestBody: - content: - application/json: - schema: - type: object - properties: - description: - type: string - minLength: 1 + parameters: + - name: enterprise-id + in: header + required: true + schema: + type: string + minLength: 1 + - name: user-id + in: header + required: true + schema: + type: string + minLength: 1 responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/V1GlobalListingResponse' + $ref: '#/components/schemas/V1GlobalListingWithListingEntries' '400': description: Bad Request content: @@ -2153,20 +2250,8 @@ paths: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' - '403': - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/V1ErrorResponse' - '409': - description: Conflict - content: - application/json: - schema: - $ref: '#/components/schemas/V1ErrorResponse' - '422': - description: Unprocessable Entity + '404': + description: Not Found content: application/json: schema: @@ -2177,20 +2262,43 @@ paths: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' - get: - summary: Get enterprise listing - description: Get the enterprise listing and list all entries in the enterprise listing. - operationId: V1GetListingRoute + post: + summary: Create enterprise listing + description: |- + Create a listing for your enterprise in the Go network. + Once you create a listing for your enterprise, you can list your Go Account in the public directory. + operationId: V1PostListingRoute tags: - Counterparties - parameters: [] + parameters: + - name: enterprise-id + in: header + required: true + schema: + type: string + minLength: 1 + - name: user-id + in: header + required: true + schema: + type: string + minLength: 1 + requestBody: + content: + application/json: + schema: + type: object + properties: + description: + type: string + minLength: 1 responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/V1GlobalListingWithListingEntries' + $ref: '#/components/schemas/V1GlobalListingResponse' '400': description: Bad Request content: @@ -2204,8 +2312,20 @@ paths: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' - '404': - description: Not Found + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/V1ErrorResponse' + '409': + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/V1ErrorResponse' + '422': + description: Unprocessable Entity content: application/json: schema: