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

Jump to bottom

docs: Storage policies: endpoints only accessible by admin #330

Merged
merged 4 commits into from
Aug 21, 2023
Merged

docs: Storage policies: endpoints only accessible by admin #330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9a8f1a7
Add information on access and auth
superojla Jul 10, 2023
a4d535d
Correct wording
superojla Jul 11, 2023
17d988d
Merge branch 'main' into DDOC-690-storage-policy-admin
superojla Jul 11, 2023
e91cee5
Merge branch 'main' into DDOC-690-storage-policy-admin
bszwarc Aug 21, 2023
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
2 changes: 2 additions & 0 deletions content/paths/storage_policies__get_storage_policies.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ x-box-tag: storage_policies

description: |-
Fetches all the storage policies in the enterprise.
Only a Primary Admin can access this endpoint. The user
needs to generate a token for an account to authenticate this request.

parameters:
- $ref: '../attributes/fields.yml'
Expand Down
2 changes: 2 additions & 0 deletions content/paths/storage_policies__get_storage_policies_id.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ tags:
x-box-tag: storage_policies

description: Fetches a specific storage policy.
Only a Primary Admin can access this endpoint. The user
needs to generate a token for an account to authenticate this request.

parameters:
- $ref: '../attributes/storage_policy_id.yml'
Expand Down
3 changes: 3 additions & 0 deletions content/paths/storage_policy_assignments__delete_storage_policy_assignments_id.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ description: |-
There is a rate limit for calling this endpoint of only
twice per user in a 24 hour time frame.

Only a Primary Admin can access this endpoint. The user
needs to generate a token for an account to authenticate this request.

parameters:
- $ref: '../attributes/storage_policy_assignment_id.yml'

Expand Down
2 changes: 2 additions & 0 deletions content/paths/storage_policy_assignments__get_storage_policy_assignments.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ x-box-tag: storage_policy_assignments

description: |-
Fetches all the storage policy assignment for an enterprise or user.
Only a Primary Admin can access this endpoint. The user
needs to generate a token for an account to authenticate this request.

parameters:
- $ref: '../attributes/marker.yml'
Expand Down
2 changes: 2 additions & 0 deletions content/paths/storage_policy_assignments__get_storage_policy_assignments_id.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ tags:
x-box-tag: storage_policy_assignments

description: Fetches a specific storage policy assignment.
Only a Primary Admin can access this endpoint. The user
needs to generate a token for an account to authenticate this request.

parameters:
- $ref: '../attributes/storage_policy_assignment_id.yml'
Expand Down
2 changes: 2 additions & 0 deletions content/paths/storage_policy_assignments__post_storage_policy_assignments.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ x-box-tag: storage_policy_assignments

description: |-
Creates a storage policy assignment for an enterprise or user.
Only a Primary Admin can access this endpoint. The user
needs to generate a token for an account to authenticate this request.

requestBody:
content:
Expand Down
2 changes: 2 additions & 0 deletions content/paths/storage_policy_assignments__put_storage_policy_assignments_id.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ tags:
x-box-tag: storage_policy_assignments

description: Updates a specific storage policy assignment.
Only a Primary Admin can access this endpoint. The user
needs to generate a token for an account to authenticate this request.

parameters:
- $ref: '../attributes/storage_policy_assignment_id.yml'
Expand Down
Loading