[#42552] add additional description to the endpoint documentation

pull/10703/head
Eric Schubert 2 years ago
parent 03860fad6b
commit d9b250b302
No known key found for this signature in database
GPG Key ID: 1D346C019BD4BAA2
  1. 3
      docs/api/apiv3/paths/storage.yml
  2. 3
      docs/api/apiv3/paths/work_package_file_links.yml

@ -6,7 +6,8 @@ get:
tags:
- File links
description: |-
Gets a storage resource.
Gets a storage resource. As a side effect, a live connection to the storages origin is established to retrieve
connection state data.
parameters:
- name: id
description: Storage id

@ -118,6 +118,9 @@ get:
- File links
description: |-
Gets all file links of a work package.
As a side effect, for every file link a request is sent to the storage's origin to fetch live data and patch
the file link's data before returning, as well as retrieving permissions of the user on this origin file.
parameters:
- name: id
description: Work package id

Loading…
Cancel
Save