CollectionsApi
All URIs are relative to //api.estuary.tech/
| Method | HTTP request | Description |
|---|---|---|
| CollectionsColuuidCommitPost | Post /collections/{coluuid}/commit | Produce a CID of the collection contents |
| CollectionsColuuidContentsDelete | Delete /collections/{coluuid}/contents | Deletes a content from a collection |
| CollectionsColuuidDelete | Delete /collections/{coluuid} | Deletes a collection |
| CollectionsColuuidGet | Get /collections/{coluuid} | Get contents in a collection |
| CollectionsColuuidPost | Post /collections/{coluuid} | Add contents to a collection |
| CollectionsFsAddPost | Post /collections/fs/add | Add a file to a collection |
| CollectionsGet | Get /collections/ | List all collections |
| CollectionsPost | Post /collections/ | Create a new collection |
CollectionsColuuidCommitPost
string CollectionsColuuidCommitPost(ctx, coluuid) Produce a CID of the collection contents
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.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| coluuid | string | coluuid |
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CollectionsColuuidContentsDelete
string CollectionsColuuidContentsDelete(ctx, body, coluuid) Deletes a content from a collection
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
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | ApiDeleteContentFromCollectionBody | Variable to use when filtering for files (must be either 'path' or 'content_id') | |
| coluuid | string | Collection ID |
Return type
string
Authorization
HTTP request headers
- Content-Type: /
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CollectionsColuuidDelete
string CollectionsColuuidDelete(ctx, coluuid) Deletes a collection
This endpoint is used to delete an existing collection.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| coluuid | string | Collection ID |
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CollectionsColuuidGet
[]CollectionsCollectionListResponse CollectionsColuuidGet(ctx, coluuid, optional) Get contents in a collection
This endpoint is used to get contents in a collection. If no colpath query param is passed
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| coluuid | string | coluuid | |
| optional | *CollectionsApiCollectionsColuuidGetOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a CollectionsApiCollectionsColuuidGetOpts struct Name | Type | Description | Notes ------------- | ------------- | ------------- | -------------
dir | optional.String| Directory |
Return type
[]CollectionsCollectionListResponse
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CollectionsColuuidPost
string CollectionsColuuidPost(ctx, body, coluuid, optional) Add contents to a collection
This endpoint adds already-pinned contents (that have ContentIDs) to a collection.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | []int32 | Content IDs to add to collection | |
| coluuid | string | Collection UUID | |
| optional | *CollectionsApiCollectionsColuuidPostOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a CollectionsApiCollectionsColuuidPostOpts struct Name | Type | Description | Notes ------------- | ------------- | ------------- | -------------
dir | optional.| Directory | overwrite | optional.| Overwrite conflicting files |
Return type
string
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CollectionsFsAddPost
string CollectionsFsAddPost(ctx, coluuid, content, optional) Add a file to a collection
This endpoint adds a file to a collection
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| coluuid | string | Collection ID | |
| content | string | Content | |
| optional | *CollectionsApiCollectionsFsAddPostOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a CollectionsApiCollectionsFsAddPostOpts struct Name | Type | Description | Notes ------------- | ------------- | ------------- | -------------
dir | optional.String| Directory inside collection | overwrite | optional.String| Overwrite file if already exists in path |
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CollectionsGet
[]CollectionsCollection CollectionsGet(ctx, ) List all collections
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.
Required Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CollectionsPost
CollectionsCollection CollectionsPost(ctx, body) Create a new collection
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.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | ApiCreateCollectionBody | Collection name and description |
Return type
Authorization
HTTP request headers
- Content-Type: /
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]