{ "opencollection": "1.0.0", "info": { "name": "Lance Namespace Specification Data Tag API", "version": "1.0.0" }, "request": { "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Tag", "type": "folder" }, "items": [ { "info": { "name": "List all tags for a table", "type": "http" }, "http": { "method": "POST", "url": "{scheme}://{host}:{port}/{basePath}/v1/table/:id/tags/list", "params": [ { "name": "id", "value": "", "type": "path", "description": "`string identifier` of an object in a namespace, following the Lance Namespace spec.\nWhen the value is equal to the delimiter, it represents the root namespace.\nFor example, `v1/namespace/$/list` performs a `ListNamespace` on the root namespace.\n" }, { "name": "delimiter", "value": "", "type": "query", "description": "An optional delimiter of the `string identifier`, following the Lance Namespace spec.\nWhen not specified, the `$` delimiter must be used.\n" }, { "name": "page_token", "value": "", "type": "query", "description": "Pagination token from a previous request" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" } ] }, "docs": "List all tags that have been created for table `id`.\nReturns a map of tag names to their corresponding version numbers and metadata.\n\nREST NAMESPACE ONLY\nREST namespace does not use a request body for this operation.\nThe `ListTableTagsRequest` information is passed in the following way:\n- `id`: pass through path parameter of the same name\n- `page_token`: pass through query parameter of the same name\n- `limit`: pass through query parameter of the same name\n" }, { "info": { "name": "Get version for a specific tag", "type": "http" }, "http": { "method": "POST", "url": "{scheme}://{host}:{port}/{basePath}/v1/table/:id/tags/version", "params": [ { "name": "id", "value": "", "type": "path", "description": "`string identifier` of an object in a namespace, following the Lance Namespace spec.\nWhen the value is equal to the delimiter, it represents the root namespace.\nFor example, `v1/namespace/$/list` performs a `ListNamespace` on the root namespace.\n" }, { "name": "delimiter", "value": "", "type": "query", "description": "An optional delimiter of the `string identifier`, following the Lance Namespace spec.\nWhen not specified, the `$` delimiter must be used.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get the version number that a specific tag points to for table `id`.\n" }, { "info": { "name": "Create a new tag", "type": "http" }, "http": { "method": "POST", "url": "{scheme}://{host}:{port}/{basePath}/v1/table/:id/tags/create", "params": [ { "name": "id", "value": "", "type": "path", "description": "`string identifier` of an object in a namespace, following the Lance Namespace spec.\nWhen the value is equal to the delimiter, it represents the root namespace.\nFor example, `v1/namespace/$/list` performs a `ListNamespace` on the root namespace.\n" }, { "name": "delimiter", "value": "", "type": "query", "description": "An optional delimiter of the `string identifier`, following the Lance Namespace spec.\nWhen not specified, the `$` delimiter must be used.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new tag for table `id` that points to a specific version.\n" }, { "info": { "name": "Delete a tag", "type": "http" }, "http": { "method": "POST", "url": "{scheme}://{host}:{port}/{basePath}/v1/table/:id/tags/delete", "params": [ { "name": "id", "value": "", "type": "path", "description": "`string identifier` of an object in a namespace, following the Lance Namespace spec.\nWhen the value is equal to the delimiter, it represents the root namespace.\nFor example, `v1/namespace/$/list` performs a `ListNamespace` on the root namespace.\n" }, { "name": "delimiter", "value": "", "type": "query", "description": "An optional delimiter of the `string identifier`, following the Lance Namespace spec.\nWhen not specified, the `$` delimiter must be used.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete an existing tag from table `id`.\n" }, { "info": { "name": "Update a tag to point to a different version", "type": "http" }, "http": { "method": "POST", "url": "{scheme}://{host}:{port}/{basePath}/v1/table/:id/tags/update", "params": [ { "name": "id", "value": "", "type": "path", "description": "`string identifier` of an object in a namespace, following the Lance Namespace spec.\nWhen the value is equal to the delimiter, it represents the root namespace.\nFor example, `v1/namespace/$/list` performs a `ListNamespace` on the root namespace.\n" }, { "name": "delimiter", "value": "", "type": "query", "description": "An optional delimiter of the `string identifier`, following the Lance Namespace spec.\nWhen not specified, the `$` delimiter must be used.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing tag for table `id` to point to a different version.\n" } ] } ], "bundled": true }