Merge pull request #15408 from eduardoj/documentation/fix_source_project

Fix API documentation related to `/source/{project_name}...` endpoints
openSUSE · Dec 21, 2023 · 4bd033f · 4bd033f
2 parents 8dfef1b + fd56c01
commit 4bd033f
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/src/api/public/apidocs/paths/source_project_name.yaml b/src/api/public/apidocs/paths/source_project_name.yaml
@@ -9,7 +9,7 @@ get:
       in: query
       schema:
         type: string
-      description: Set to `1` to list the deleted packages of a project.
+      description: Set to `1` to list the packages of a deleted project.
       example: 1
     - in: query
       name: expand

diff --git a/src/api/public/apidocs/paths/source_project_name_project_file.yaml b/src/api/public/apidocs/paths/source_project_name_project_file.yaml
@@ -7,12 +7,18 @@ get:
   parameters:
     - $ref: '../components/parameters/project_name.yaml'
     - $ref: '../components/parameters/file_name.yaml'
+    - name: deleted
+      in: query
+      schema:
+        type: string
+      description: Set to `1` to read a file of a deleted project.
+      example: 1
     - in: query
       name: meta
       required: false
       schema:
         type: integer
-      description: Set to 1 to include _meta files
+      description: Set to `1` to include _meta files
       example: 1
     - in: query
       name: rev