Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing fields in storage doc #5051

Merged
merged 1 commit into from
Jul 1, 2024
Merged

Add missing fields in storage doc #5051

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/src/main/paradox/docs/delta/api/storages-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ local file-system structure and that Nexus has read and write access to the targ
```json
{
"@type": "DiskStorage",
"name": "{name}",
"description": "{description}",
"default": "{default}",
"volume": "{volume}",
"readPermission": "{read_permission}",
Expand All @@ -42,6 +44,8 @@ local file-system structure and that Nexus has read and write access to the targ

...where

- `{name}`: String - A name for this storage. This field is optional.
- `{description}`: String - A description for this storage. This field is optional.
- `{default}`: Boolean - the flag to decide whether this storage is going to become the default storage for the target project or not.
- `{volume}`: String - the path to the local file-system volume where files using this storage will be stored. This field is optional, defaulting to the configuration flag `plugins.storage.storages.disk.default-volume` (`/tmp`).
- `{read_permission}`: String - the permission a client must have in order to fetch files using this storage. This field is optional, defaulting to the configuration flag `plugins.storage.storages.disk.default-read-permission` (`resources/read`).
Expand All @@ -68,6 +72,8 @@ In order to be able to use this storage, the configuration flag `plugins.storage
```json
{
"@type": "RemoteDiskStorage",
"name": "{name}",
"description": "{description}",
"default": "{default}",
"folder": "{folder}",
"readPermission": "{read_permission}",
Expand All @@ -78,6 +84,8 @@ In order to be able to use this storage, the configuration flag `plugins.storage

...where

- `{name}`: String - A name for this storage. This field is optional.
- `{description}`: String - A description for this storage. This field is optional.
- `{default}`: Boolean - the flag to decide whether this storage is going to become the default storage for the target project or not.
- `{folder}`: String - the storage service bucket where files using this storage are going to be saved.
- `{read_permission}`: String - the permission a client must have in order to fetch files using this storage. This field is optional, defaulting to the configuration flag `plugins.storage.storages.remote-disk.default-read-permission` (`resources/read`).
Expand All @@ -93,6 +101,9 @@ In order to be able to use this storage, the configuration flag `plugins.storage
```json
{
"@type": "S3Storage",
"name": "{name}",
"description": "{description}",
"bucket": "{name}",
"default": "{default}",
"readPermission": "{read_permission}",
"writePermission": "{write_permission}",
Expand All @@ -102,6 +113,9 @@ In order to be able to use this storage, the configuration flag `plugins.storage

...where

- `{name}`: String - A name for this storage. This field is optional.
- `{description}`: String - A description for this storage. This field is optional.
- `{bucket}`: String -The AWS S3 bucket this storage points to. This field is optional, defaulting to the configuration flag `plugins.storage.storages.amazon.default-endpoint`.
- `{default}`: Boolean - the flag to decide whether this storage is going to become the default storage for the target project or not.
- `{read_permission}`: String - the permission a client must have in order to fetch files using this storage. This field is optional, defaulting to the configuration flag `plugins.storage.storages.amazon.default-read-permission` (`resources/read`).
- `{write_permission}`: String - the permission a client must have in order to create files using this storage. This field is optional, defaulting to the configuration flag `plugins.storage.storages.amazon.default-write-permission` (`files/write`).
Expand Down