#184: Make response descriptions have consistent syntax

- The commit also includes a rebuilt openapi.yaml
ral-facilities · Dec 8, 2020 · fe88196 · fe88196
1 parent b01eaf5
commit fe88196
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/datagateway_api/src/resources/non_entities/sessions_endpoints.py b/datagateway_api/src/resources/non_entities/sessions_endpoints.py
@@ -50,9 +50,9 @@ def post(self):
                       description: Session ID
                       example: xxxxxx-yyyyyyy-zzzzzz
           400:
-            description: Bad request. User credentials not provided in request body
+            description: Bad request - User credentials not provided in request body
           403:
-             description: Forbidden. User credentials were invalid
+             description: Forbidden - User credentials were invalid
         """
         if not (
             request.data and "username" in request.json and "password" in request.json

diff --git a/datagateway_api/src/swagger/openapi.yaml b/datagateway_api/src/swagger/openapi.yaml
@@ -87,9 +87,9 @@ components:
       schema:
         type: integer
     WHERE_FILTER:
-      description: Apply where filters to the query. The possible operators are like,
-        gte, lte, in and eq. Please modify the examples before executing a request
-        if you are having issues with the example values.
+      description: 'Apply where filters to the query. The possible operators are:
+        ne, like, lt, lte, gt, gte, in and eq. Please modify the examples before executing
+        a request if you are having issues with the example values.'
       examples:
         eq:
           value:
@@ -10817,9 +10817,9 @@ paths:
                 type: object
           description: Success - returns a session ID
         '400':
-          description: Bad request. User credentials not provided in request body
+          description: Bad request - User credentials not provided in request body
         '403':
-          description: Forbidden. User credentials were invalid
+          description: Forbidden - User credentials were invalid
       security: []
       summary: Login
       tags: