Last active
November 21, 2022 14:34
-
-
Save gmelodie/707a4e726214f7afad0d89a4c136955d to your computer and use it in GitHub Desktop.
Swagger docs for new estuary api (v1)
This file contains 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
| swagger: '2.0' | |
| info: | |
| description: This is the API for the Estuary application. | |
| title: Estuary API | |
| termsOfService: http://estuary.tech | |
| contact: | |
| name: API Support | |
| url: https://docs.estuary.tech/feedback | |
| license: | |
| name: Apache 2.0 Apache-2.0 OR MIT | |
| url: https://github.com/application-research/estuary/blob/master/LICENSE.md | |
| version: 0.0.0 | |
| host: api.estuary.tech | |
| basePath: / | |
| paths: | |
| /autoretrieve: | |
| post: | |
| description: This endpoint registers a new autoretrieve server | |
| produces: | |
| - application/json | |
| consumes: | |
| - multipart/form-data | |
| tags: | |
| - autoretrieve | |
| summary: Register autoretrieve server | |
| parameters: | |
| - type: string | |
| description: Autoretrieve's comma-separated list of addresses | |
| name: addresses | |
| in: formData | |
| required: true | |
| - type: string | |
| description: Autoretrieve's public key | |
| name: pubKey | |
| in: formData | |
| required: true | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| get: | |
| description: This endpoint lists all registered autoretrieve servers | |
| produces: | |
| - application/json | |
| tags: | |
| - autoretrieve | |
| summary: List autoretrieve servers | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /peering-peers: | |
| get: | |
| description: This endpoint can be used to list all peers on Peering Service | |
| produces: | |
| - application/json | |
| tags: | |
| - peering-peers | |
| summary: List all Peering peers | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| post: | |
| description: This endpoint can be used to add a Peer from the Peering Service | |
| produces: | |
| - application/json | |
| tags: | |
| - peering-peers | |
| summary: Add peers on Peering Service | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| delete: | |
| description: This endpoint can be used to remove a Peer from the Peering Service | |
| produces: | |
| - application/json | |
| tags: | |
| - peering-peers | |
| summary: Remove peers on Peering Service | |
| parameters: | |
| - description: Peer ids | |
| name: peerIds | |
| in: body | |
| required: true | |
| schema: | |
| type: array | |
| items: | |
| type: boolean | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /peering/start: | |
| post: | |
| description: This endpoint can be used to start the Peering Service | |
| produces: | |
| - application/json | |
| tags: | |
| - peering | |
| summary: Start Peering | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /peering/stop: | |
| post: | |
| description: This endpoint can be used to stop the Peering Service | |
| produces: | |
| - application/json | |
| tags: | |
| - peering | |
| summary: Stop Peering | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /peering/status: | |
| get: | |
| description: This endpoint can be used to check the Peering status | |
| produces: | |
| - application/json | |
| tags: | |
| - peering | |
| summary: Check Peering Status | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /users: | |
| get: | |
| description: This endpoint is used to get all users. | |
| produces: | |
| - application/json | |
| tags: | |
| - users | |
| summary: Get all users | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /autoretrieve/heartbeat: | |
| post: | |
| description: This endpoint updates the lastConnection field for autoretrieve | |
| produces: | |
| - application/json | |
| tags: | |
| - autoretrieve | |
| summary: Marks autoretrieve server as up | |
| parameters: | |
| - type: string | |
| description: Autoretrieve's auth token | |
| name: token | |
| in: header | |
| required: true | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /collections/: | |
| get: | |
| description: >- | |
| This endpoint is used to list all collections. Whenever a user logs on | |
| estuary, it will list all collections that the user has access to. This | |
| endpoint provides a way to list all collections to the user. | |
| produces: | |
| - application/json | |
| tags: | |
| - collections | |
| summary: List all collections | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| type: array | |
| items: | |
| $ref: '#/definitions/collections.Collection' | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '404': | |
| description: Not Found | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| post: | |
| description: >- | |
| This endpoint is used to create a new collection. A collection is a | |
| representaion of a group of objects added on the estuary. This endpoint | |
| can be used to create a new collection. | |
| produces: | |
| - application/json | |
| tags: | |
| - collections | |
| summary: Create a new collection | |
| parameters: | |
| - description: Collection name and description | |
| name: body | |
| in: body | |
| required: true | |
| schema: | |
| $ref: '#/definitions/main.createCollectionBody' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/collections.Collection' | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '404': | |
| description: Not Found | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /collections/{coluuid}: | |
| get: | |
| description: >- | |
| This endpoint is used to get contents in a collection. If no colpath | |
| query param is passed | |
| produces: | |
| - application/json | |
| tags: | |
| - collections | |
| summary: Get contents in a collection | |
| parameters: | |
| - type: string | |
| description: coluuid | |
| name: coluuid | |
| in: path | |
| required: true | |
| - type: string | |
| description: Directory | |
| name: dir | |
| in: query | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| post: | |
| description: >- | |
| This endpoint adds already-pinned contents (that have ContentIDs) to a | |
| collection. | |
| consumes: | |
| - application/json | |
| produces: | |
| - application/json | |
| tags: | |
| - collections | |
| summary: Add contents to a collection | |
| parameters: | |
| - type: string | |
| description: coluuid | |
| name: coluuid | |
| in: path | |
| required: true | |
| - description: Content IDs to add to collection | |
| name: contentIDs | |
| in: body | |
| required: true | |
| schema: | |
| type: array | |
| items: | |
| type: integer | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| delete: | |
| description: This endpoint is used to delete an existing collection. | |
| tags: | |
| - collections | |
| summary: Deletes a collection | |
| parameters: | |
| - type: string | |
| description: Collection ID | |
| name: coluuid | |
| in: path | |
| required: true | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /collections/{coluuid}/commit: | |
| post: | |
| description: >- | |
| This endpoint is used to save the contents in a collection, producing a | |
| top-level CID that references all the current CIDs in the collection. | |
| produces: | |
| - application/json | |
| tags: | |
| - collections | |
| summary: Produce a CID of the collection contents | |
| parameters: | |
| - type: string | |
| description: coluuid | |
| name: coluuid | |
| in: path | |
| required: true | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /collections/{coluuid}/contents: | |
| delete: | |
| description: >- | |
| This endpoint is used to delete an existing content from an existing | |
| collection. If two or more files with the same contentid exist in the | |
| collection, delete the one in the specified path | |
| produces: | |
| - application/json | |
| tags: | |
| - collections | |
| summary: Deletes a content from a collection | |
| parameters: | |
| - type: string | |
| description: Collection ID | |
| name: coluuid | |
| in: path | |
| required: true | |
| - description: >- | |
| Variable to use when filtering for files (must be either 'path' or | |
| 'content_id') | |
| name: body | |
| in: body | |
| required: true | |
| schema: | |
| $ref: '#/definitions/main.deleteContentFromCollectionBody' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /contents: | |
| post: | |
| description: This endpoint is used to upload new content. | |
| consumes: | |
| - multipart/form-data | |
| produces: | |
| - application/json | |
| tags: | |
| - contents | |
| summary: Add new content | |
| parameters: | |
| - type: file | |
| description: File to upload | |
| name: data | |
| in: formData | |
| required: true | |
| - type: string | |
| description: Filename to use for upload | |
| name: filename | |
| in: formData | |
| - type: string | |
| description: Content type to add (car, cid, file) | |
| name: type | |
| in: query | |
| required: true | |
| - type: string | |
| description: Collection UUID | |
| name: coluuid | |
| in: query | |
| - type: integer | |
| description: Replication value | |
| name: replication | |
| in: query | |
| - type: string | |
| description: Ignore Dupes true/false | |
| name: ignore-dupes | |
| in: query | |
| - type: string | |
| description: Lazy Provide true/false | |
| name: lazy-provide | |
| in: query | |
| - type: string | |
| description: Directory | |
| name: dir | |
| in: query | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/util.ContentAddResponse' | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| get: | |
| description: This endpoint lists all content | |
| produces: | |
| - application/json | |
| tags: | |
| - contents | |
| summary: List pinned content | |
| parameters: | |
| - type: boolean | |
| description: Show all contents that have sealed deals | |
| name: type | |
| in: query | |
| required: false | |
| - type: string | |
| description: Show all contents related to this CID | |
| name: cid | |
| in: query | |
| required: false | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /contents/{contentid}: | |
| get: | |
| description: This endpoint returns a content by its ID | |
| produces: | |
| - application/json | |
| tags: | |
| - contents | |
| summary: Get a content | |
| parameters: | |
| - type: integer | |
| description: Content ID | |
| name: contentid | |
| in: path | |
| required: true | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| delete: | |
| description: This endpoint deletes a content by its ID | |
| produces: | |
| - application/json | |
| tags: | |
| - contents | |
| summary: Delete a content | |
| parameters: | |
| - type: integer | |
| description: Content ID | |
| name: contentid | |
| in: path | |
| required: true | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /contents/{contentid}/aggregated: | |
| get: | |
| description: This endpoint returns aggregated content stats | |
| produces: | |
| - application/json | |
| tags: | |
| - contents | |
| summary: Get aggregated content stats | |
| parameters: | |
| - type: string | |
| description: Content ID | |
| name: contentid | |
| in: path | |
| required: true | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /contents/stats: | |
| get: | |
| description: >- | |
| This endpoint is used to get content statistics. Every content stored in | |
| the network (estuary) is tracked by a unique ID which can be used to get | |
| information about the content. This endpoint will allow the consumer to | |
| get the collected stats of a conten | |
| produces: | |
| - application/json | |
| tags: | |
| - contents | |
| summary: Get content statistics | |
| parameters: | |
| - type: string | |
| description: limit | |
| name: limit | |
| in: query | |
| required: true | |
| - type: string | |
| description: offset | |
| name: offset | |
| in: query | |
| required: true | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /contents/{contentid}/status: | |
| get: | |
| description: This endpoint returns the status of a content | |
| produces: | |
| - application/json | |
| tags: | |
| - contents | |
| summary: Content Status | |
| parameters: | |
| - type: integer | |
| description: Content ID | |
| name: contentid | |
| in: path | |
| required: true | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /deals: | |
| post: | |
| description: This endpoint makes a deal for a given content and miner | |
| produces: | |
| - application/json | |
| tags: | |
| - deals | |
| summary: Make a deal for content with miner | |
| parameters: | |
| - description: Deal Request | |
| name: dealRequest | |
| in: body | |
| required: true | |
| schema: | |
| $ref: '#/definitions/dealRequest' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /deals/import: | |
| post: | |
| description: This endpoint imports a deal into the shuttle. | |
| produces: | |
| - application/json | |
| tags: | |
| - deals | |
| summary: Import a deal | |
| parameters: | |
| - description: Import a deal | |
| name: body | |
| in: body | |
| required: true | |
| schema: | |
| $ref: '#/definitions/main.importDealBody' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /deals/estimate: | |
| post: | |
| description: This endpoint estimates the cost of a deal | |
| produces: | |
| - application/json | |
| tags: | |
| - deals | |
| summary: Estimate the cost of a deal | |
| parameters: | |
| - description: >- | |
| The size of the deal in bytes, the replication factor, and the | |
| duration of the deal in blocks | |
| name: body | |
| in: body | |
| required: true | |
| schema: | |
| $ref: '#/definitions/main.estimateDealBody' | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /deals/{dealid}/info: | |
| get: | |
| description: This endpoint returns the deal info for a deal | |
| produces: | |
| - application/json | |
| tags: | |
| - deals | |
| summary: Get Deal Info | |
| parameters: | |
| - type: integer | |
| description: Deal ID | |
| name: dealid | |
| in: path | |
| required: true | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /deals/{dealid}/status: | |
| get: | |
| description: Get Deal Status by PropCid | |
| produces: | |
| - application/json | |
| tags: | |
| - deals | |
| summary: Get Deal Status by PropCid | |
| parameters: | |
| - type: string | |
| description: Deal ID | |
| required: true | |
| name: dealid | |
| in: path | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /deals/failure-errors: | |
| get: | |
| description: This endpoint returns a list of storage failures for user | |
| produces: | |
| - application/json | |
| tags: | |
| - deals | |
| summary: Get storage failures for user | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /proposals/{proposalcid}: | |
| get: | |
| description: This endpoint returns the proposal for a deal | |
| produces: | |
| - application/json | |
| tags: | |
| - proposals | |
| summary: Get Proposal | |
| parameters: | |
| - type: string | |
| description: Proposal CID | |
| name: proposalcid | |
| in: path | |
| required: true | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /proposals/{proposalcid}/deal-status: | |
| get: | |
| description: This endpoint returns the status of a deal | |
| produces: | |
| - application/json | |
| tags: | |
| - proposals | |
| summary: Deal Status | |
| parameters: | |
| - type: string | |
| description: The CID of the proposal for the deal | |
| name: proposalcid | |
| in: path | |
| required: true | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /transfers: | |
| get: | |
| description: This endpoint returns the in-progress transfers | |
| produces: | |
| - application/json | |
| tags: | |
| - transfers | |
| summary: Query transfers | |
| parameters: | |
| - description: Filter for transfers that are currently in progress | |
| name: in-progress | |
| type: boolean | |
| in: query | |
| required: false | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /pins: | |
| get: | |
| description: This endpoint lists all pin status objects | |
| produces: | |
| - application/json | |
| tags: | |
| - pins | |
| summary: List all pin status objects | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/types.IpfsListPinStatusResponse' | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| post: | |
| description: This endpoint adds a pin to the IPFS daemon. | |
| produces: | |
| - application/json | |
| tags: | |
| - pins | |
| summary: Add and pin object | |
| parameters: | |
| - description: Pin Body {cid:cid, name:name} | |
| name: pin | |
| in: body | |
| required: true | |
| schema: | |
| $ref: '#/definitions/types.IpfsPin' | |
| responses: | |
| '202': | |
| description: Accepted | |
| schema: | |
| $ref: '#/definitions/types.IpfsPinStatusResponse' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /pins/{pinid}: | |
| get: | |
| description: This endpoint returns a pin status object. | |
| produces: | |
| - application/json | |
| tags: | |
| - pins | |
| summary: Get a pin status object | |
| parameters: | |
| - type: string | |
| description: cid | |
| name: pinid | |
| in: path | |
| required: true | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/types.IpfsPinStatusResponse' | |
| '404': | |
| description: Not Found | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| post: | |
| description: This endpoint replaces a pinned object. | |
| produces: | |
| - application/json | |
| tags: | |
| - pins | |
| summary: Replace a pinned object | |
| parameters: | |
| - type: string | |
| description: Pin ID to be replaced | |
| name: pinid | |
| in: path | |
| required: true | |
| - description: New pin | |
| name: pin | |
| in: body | |
| required: true | |
| schema: | |
| $ref: '#/definitions/types.IpfsPin' | |
| responses: | |
| '202': | |
| description: Accepted | |
| schema: | |
| $ref: '#/definitions/types.IpfsPinStatusResponse' | |
| '404': | |
| description: Not Found | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| delete: | |
| description: This endpoint deletes a pinned object. | |
| produces: | |
| - application/json | |
| tags: | |
| - pins | |
| summary: Delete a pinned object | |
| parameters: | |
| - type: string | |
| description: Pin ID | |
| name: pinid | |
| in: path | |
| required: true | |
| responses: | |
| '202': | |
| description: '' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /node: | |
| get: | |
| description: This endpoint returns information about this API node | |
| produces: | |
| - application/json | |
| tags: | |
| - node | |
| summary: Get public node info | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /metrics/deals-on-chain: | |
| get: | |
| description: This endpoint is used to get deal metrics | |
| produces: | |
| - application/json | |
| tags: | |
| - metrics | |
| summary: Get deal metrics | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /node/config: | |
| get: | |
| description: This endpoint is used to get system configs. | |
| produces: | |
| - application/json | |
| tags: | |
| - node | |
| summary: Get systems estuary/shuttle config | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /miners/{miner}/deals: | |
| get: | |
| description: This endpoint returns all miners deals | |
| produces: | |
| - application/json | |
| tags: | |
| - miners | |
| summary: Get all miners deals | |
| parameters: | |
| - type: string | |
| description: Filter by miner | |
| name: miner | |
| in: path | |
| required: true | |
| - type: string | |
| description: Ignore Failed | |
| name: ignore-failed | |
| in: query | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /miners/{miner}/queryask: | |
| get: | |
| description: This endpoint returns the ask for a given CID on a certain miner | |
| produces: | |
| - application/json | |
| tags: | |
| - miners | |
| summary: Query Ask | |
| parameters: | |
| - type: string | |
| description: CID | |
| name: miner | |
| in: path | |
| required: true | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /miners/{miner}/stats: | |
| get: | |
| description: This endpoint returns miner stats | |
| produces: | |
| - application/json | |
| tags: | |
| - miners | |
| summary: Get miner stats | |
| parameters: | |
| - type: string | |
| description: Filter by miner | |
| name: miner | |
| in: path | |
| required: true | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /keys: | |
| get: | |
| description: >- | |
| This endpoint is used to get API keys for a user. In estuary, each user | |
| can be given multiple API keys (tokens). This endpoint can be used to | |
| retrieve all available API keys for a given user. | |
| produces: | |
| - application/json | |
| tags: | |
| - keys | |
| summary: Get API keys for a user | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: array | |
| items: | |
| type: array | |
| items: | |
| $ref: '#/definitions/main.getApiKeysResp' | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '404': | |
| description: Not Found | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| post: | |
| description: >- | |
| This endpoint is used to create API keys for a user. In estuary, each | |
| user is given an API key to access all features. | |
| produces: | |
| - application/json | |
| tags: | |
| - keys | |
| summary: Create API keys for a user | |
| parameters: | |
| - type: string | |
| description: >- | |
| Expiration - Expiration - Valid time units are ns, us (or µs), ms, | |
| s, m, h. for example 300h | |
| name: expiry | |
| in: query | |
| - type: string | |
| description: Permissions -- currently unused | |
| name: perms | |
| in: query | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| $ref: '#/definitions/main.getApiKeysResp' | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '404': | |
| description: Not Found | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /keys/{key_or_hash}: | |
| delete: | |
| description: >- | |
| This endpoint is used to revoke a user API key. In estuary, every user | |
| is assigned with an API key, this API key is generated and issued for | |
| each user and is primarily used to access all estuary features. This | |
| endpoint can be used to revoke the API key that's assigned to the user. | |
| Revoked API keys are completely deleted and are not recoverable. | |
| produces: | |
| - application/json | |
| tags: | |
| - keys | |
| summary: Revoke a User API Key. | |
| parameters: | |
| - type: string | |
| description: Key or Hash | |
| name: key_or_hash | |
| in: path | |
| required: true | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /users/export: | |
| get: | |
| description: This endpoint is used to get API keys for a user. | |
| produces: | |
| - application/json | |
| tags: | |
| - users | |
| summary: Export user data | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /users/stats: | |
| get: | |
| description: This endpoint is used to get stats for users. | |
| produces: | |
| - application/json | |
| tags: | |
| - users | |
| summary: Get stats for the current user | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| /staging-buckets: | |
| get: | |
| description: This endpoint is used to get staging buckets. | |
| produces: | |
| - application/json | |
| tags: | |
| - staging-buckets | |
| summary: Get all staging buckets for current user | |
| responses: | |
| '200': | |
| description: OK | |
| schema: | |
| type: string | |
| '400': | |
| description: Bad Request | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| '500': | |
| description: Internal Server Error | |
| schema: | |
| $ref: '#/definitions/util.HttpError' | |
| definitions: | |
| collections.Collection: | |
| type: object | |
| properties: | |
| cid: | |
| type: string | |
| createdAt: | |
| type: string | |
| description: | |
| type: string | |
| name: | |
| type: string | |
| userId: | |
| type: integer | |
| uuid: | |
| type: string | |
| main.ChannelIDParam: | |
| type: object | |
| properties: | |
| id: | |
| type: integer | |
| initiator: | |
| type: string | |
| responder: | |
| type: string | |
| main.createCollectionBody: | |
| type: object | |
| properties: | |
| description: | |
| type: string | |
| name: | |
| type: string | |
| main.deleteContentFromCollectionBody: | |
| type: object | |
| properties: | |
| by: | |
| type: string | |
| value: | |
| type: string | |
| main.estimateDealBody: | |
| type: object | |
| properties: | |
| durationBlks: | |
| type: integer | |
| replication: | |
| type: integer | |
| size: | |
| type: integer | |
| verified: | |
| type: boolean | |
| main.getApiKeysResp: | |
| type: object | |
| properties: | |
| expiry: | |
| type: string | |
| label: | |
| type: string | |
| token: | |
| type: string | |
| tokenHash: | |
| type: string | |
| main.importDealBody: | |
| type: object | |
| properties: | |
| coluuid: | |
| type: string | |
| dealIDs: | |
| type: array | |
| items: | |
| type: integer | |
| dir: | |
| type: string | |
| name: | |
| type: string | |
| types.IpfsListPinStatusResponse: | |
| type: object | |
| properties: | |
| count: | |
| type: integer | |
| results: | |
| type: array | |
| items: | |
| $ref: '#/definitions/types.IpfsPinStatusResponse' | |
| types.IpfsPin: | |
| type: object | |
| properties: | |
| cid: | |
| type: string | |
| meta: | |
| type: object | |
| additionalProperties: true | |
| name: | |
| type: string | |
| origins: | |
| type: array | |
| items: | |
| type: string | |
| types.IpfsPinStatusResponse: | |
| type: object | |
| properties: | |
| created: | |
| type: string | |
| delegates: | |
| type: array | |
| items: | |
| type: string | |
| info: | |
| type: object | |
| additionalProperties: true | |
| pin: | |
| $ref: '#/definitions/types.IpfsPin' | |
| requestid: | |
| type: string | |
| status: | |
| type: string | |
| util.ContentAddIpfsBody: | |
| type: object | |
| properties: | |
| coluuid: | |
| type: string | |
| dir: | |
| type: string | |
| filename: | |
| type: string | |
| peers: | |
| type: array | |
| items: | |
| type: string | |
| root: | |
| type: string | |
| util.ContentAddResponse: | |
| type: object | |
| properties: | |
| cid: | |
| type: string | |
| estuaryId: | |
| type: integer | |
| providers: | |
| type: array | |
| items: | |
| type: string | |
| retrieval_url: | |
| type: string | |
| util.ContentCreateBody: | |
| type: object | |
| properties: | |
| coluuid: | |
| type: string | |
| dir: | |
| type: string | |
| location: | |
| type: string | |
| name: | |
| type: string | |
| root: | |
| type: string | |
| type: | |
| type: integer | |
| dealRequest: | |
| type: object | |
| properties: | |
| content: | |
| type: string | |
| miner: | |
| type: string | |
| util.HttpError: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| details: | |
| type: string | |
| reason: | |
| type: string | |
| securityDefinitions: | |
| bearerAuth: | |
| type: apiKey | |
| name: Authorization | |
| in: header | |
| security: | |
| - bearerAuth: [] |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment