Merge branch 'RESTAPI-1082-fix-docs' into 'master'

Fix error in documentation See merge request firecrest/firecrest!297
eth-cscs · Apr 25, 2024 · 6cbeabc · 6cbeabc
2 parents acd8f2d + 430cdac
commit 6cbeabc
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 6 deletions.
diff --git a/doc/openapi/firecrest-developers-api.yaml b/doc/openapi/firecrest-developers-api.yaml
@@ -2331,6 +2331,19 @@ paths:
                 stageOutJobId: "123456"
                 time: "2-03:00:00"
                 extension: ".tar.gz"
+      responses:
+        '201':
+          description: Task created
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Task-Creation-Success'
+        '400':
+          description: Task creation error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Task-Creation-Error'
   '/storage/xfer-external/upload':
     parameters:
       - in: header

diff --git a/doc/source/reference.rst b/doc/source/reference.rst
@@ -6,5 +6,3 @@ You can find the full API `here <https://firecrest-api.cscs.ch/>`__ but some end
 
 .. openapi:: ../openapi/firecrest-developers-api.yaml
    :group:
-   :exclude:
-        /storage/xfer-external/upload-finished/{task_id}
diff --git a/doc/source/requirements.txt b/doc/source/requirements.txt
@@ -1,5 +1,5 @@
 jinja2==3.0.0
-Sphinx==1.8.2
-sphinx-rtd-theme==0.4.3
-sphinxcontrib-openapi==0.6.0
-https://github.com/djungelorm/sphinx-tabs/releases/download/v1.1.13/sphinx-tabs-1.1.13.tar.gz
+Sphinx==7.0.0
+sphinx-rtd-theme==2.0.0
+sphinxcontrib-openapi==0.8.4
+sphinx-tabs==3.4.5