Merge pull request #557 from openedx/sameen/fix-api-endpoints

fix: add missing response codes
openedx · Jan 11, 2024 · d8e8849 · d8e8849
2 parents f9c95bd + 5f2e7f0
commit d8e8849
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/api-compact.yaml b/api-compact.yaml
@@ -16,6 +16,8 @@ apigateway_responses: &apigateway_responses
     statusCode: "400"
   200:
     statusCode: "200"
+  201:
+    statusCode: "201"
   401:
     statusCode: "401"
   403:
@@ -82,6 +84,8 @@ apigateway_responses_with_mapping_template_for_uuid: &apigateway_responses_with_
 responses: &responses
   200:
     description: "OK"
+  201:
+    description: "Created"
   400:
     description: "Bad Request"
   401:
@@ -278,18 +282,21 @@ endpoints:
                   emails:
                     description: "list of learner emails"
                     type: "array"
+                    required: true
                     items:
                       type: "string"
                       description: "user email"
                   course_run_keys:
                     description: "list of courses to enroll learners into"
                     type: "array"
+                    required: true
                     items:
                       type: "string"
                       description: "course run key"
                   notify:
                     description: "Whether to notify learner of their enrollment"
                     type: "boolean"
+                    required: true
         responses: *responses
         x-amazon-apigateway-integration:
           responses: *apigateway_responses

diff --git a/api.yaml b/api.yaml
@@ -5,6 +5,8 @@
 apigateway_responses:
   "200":
     statusCode: "200"
+  "201":
+    statusCode: "201"
   "401":
     statusCode: "401"
   "403":
@@ -63,6 +65,8 @@ apigateway_responses_with_mapping_template_for_uuid:
 responses:
   "200":
     description: OK
+  "201":
+    description: Created
   "400":
     description: Bad Request
   "401":
@@ -171,6 +175,8 @@ endpoints:
         responses:
           "200":
             description: OK
+          "201":
+            description: Created
           "400":
             description: Bad Request
           "401":
@@ -187,6 +193,8 @@ endpoints:
           responses:
             "200":
               statusCode: "200"
+            "201":
+              statusCode: "201"
             "401":
               statusCode: "401"
             "403":
@@ -328,21 +336,26 @@ endpoints:
                   emails:
                     description: list of learner emails
                     type: array
+                    required: true
                     items:
                       type: string
                       description: user email
                   course_run_keys:
                     description: list of courses to enroll learners into
                     type: array
+                    required: true
                     items:
                       type: string
                       description: course run key
                   notify:
                     description: Whether to notify learner of their enrollment
                     type: boolean
+                    required: true
         responses:
           "200":
             description: OK
+          "201":
+            description: Created
           "400":
             description: Bad Request
           "401":
@@ -359,6 +372,8 @@ endpoints:
           responses:
             "200":
               statusCode: "200"
+            "201":
+              statusCode: "201"
             "401":
               statusCode: "401"
             "403":