Skip to content

Commit d9b250b

Browse files
committed
[#42552] add additional description to the endpoint documentation
1 parent 03860fa commit d9b250b

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

docs/api/apiv3/paths/storage.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ get:
66
tags:
77
- File links
88
description: |-
9-
Gets a storage resource.
9+
Gets a storage resource. As a side effect, a live connection to the storages origin is established to retrieve
10+
connection state data.
1011
parameters:
1112
- name: id
1213
description: Storage id

docs/api/apiv3/paths/work_package_file_links.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,9 @@ get:
118118
- File links
119119
description: |-
120120
Gets all file links of a work package.
121+
122+
As a side effect, for every file link a request is sent to the storage's origin to fetch live data and patch
123+
the file link's data before returning, as well as retrieving permissions of the user on this origin file.
121124
parameters:
122125
- name: id
123126
description: Work package id

0 commit comments

Comments
 (0)