Skip to content

Commit

Permalink
Remove remaining references to tags in storages docs (#4692)
Browse files Browse the repository at this point in the history
Co-authored-by: Simon <[email protected]>
  • Loading branch information
dantb and imsdu authored Jan 25, 2024
1 parent 04abfb6 commit 69f95ce
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 34 deletions.

This file was deleted.

36 changes: 3 additions & 33 deletions docs/src/main/paradox/docs/delta/api/storages-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ In order to be able to use this storage, the configuration flag `plugins.storage

## Indexing

All the API calls modifying a storage (creation, update, tagging, deprecation) can specify whether the storage should be indexed
All the API calls modifying a storage (creation, update, deprecation) can specify whether the storage should be indexed
synchronously or in the background. This behaviour is controlled using `indexing` query param, which can be one of two values:

- `async` - (default value) the storage will be indexed asynchronously
Expand Down Expand Up @@ -241,14 +241,11 @@ Response
## Fetch

```
GET /v1/storages/{org_label}/{project_label}/{storage_id}?rev={rev}&tag={tag}
GET /v1/storages/{org_label}/{project_label}/{storage_id}?rev={rev}
```
where ...

- `{rev}`: Number - the targeted revision to be fetched. This field is optional and defaults to the latest revision.
- `{tag}`: String - the targeted tag to be fetched. This field is optional.

`{rev}` and `{tag}` fields cannot be simultaneously present.

**Example**

Expand All @@ -264,15 +261,12 @@ if the `Accept` header is set to `text/html`, a redirection to the fusion repres
## Fetch original payload

```
GET /v1/storages/{org_label}/{project_label}/{storage_id}/source?rev={rev}&tag={tag}
GET /v1/storages/{org_label}/{project_label}/{storage_id}/source?rev={rev}
```

where ...

- `{rev}`: Number - the targeted revision to be fetched. This field is optional and defaults to the latest revision.
- `{tag}`: String - the targeted tag to be fetched. This field is optional.

`{rev}` and `{tag}` fields cannot be simultaneously present.

**Example**

Expand All @@ -282,30 +276,6 @@ Request
Response
: @@snip [fetched-source.json](assets/storages/fetched-source.json)

## Fetch tags

Retrieves all the tags available for the `{storage_id}`.

```
GET /v1/storages/{org_label}/{project_label}/{storage_id}/tags?rev={rev}&tag={tag}
```

where ...

- `{rev}`: Number - the targeted revision of the tags to be fetched. This field is optional and defaults to the latest revision.
- `{tag}`: String - the targeted tag of the tags to be fetched. This field is optional.

`{rev}` and `{tag}` fields cannot be simultaneously present.

**Example**

Request
: @@snip [fetch-tags.sh](assets/storages/fetch-tags.sh)

Response
: @@snip [fetched-tags.json](assets/tags.json)


## List

There are three available endpoints to list storages in different scopes.
Expand Down

0 comments on commit 69f95ce

Please sign in to comment.