Merge pull request #553 from openedx/sameen/fix-revoke-endpoint

fix: fixed response status for bulk-revoke endpoint
openedx · Jan 3, 2024 · 8ea5ecd · 8ea5ecd
2 parents 9faef7a + 1f3037b
commit 8ea5ecd
Show file tree

Hide file tree

Showing 2 changed files with 73 additions and 10 deletions.
diff --git a/api-compact.yaml b/api-compact.yaml
@@ -27,6 +27,23 @@ apigateway_responses: &apigateway_responses
   500:
     statusCode: "500"
 
+bulk_revoke_apigateway_responses: &bulk_revoke_apigateway_responses
+  default:
+    statusCode: "400"
+  204:
+    statusCode: "204"
+  401:
+    statusCode: "401"
+  403:
+    statusCode: "403"
+  404:
+    statusCode: "404"
+  429:
+    statusCode: "429"
+  500:
+    statusCode: "500"
+
+
 apigateway_responses_with_mapping_template_for_uuid: &apigateway_responses_with_mapping_template_for_uuid
   default:
     statusCode: "400"
@@ -78,6 +95,22 @@ responses: &responses
   500:
     description: "Internal Server Error"
 
+bulk_revoke_responses: &bulk_revoke_responses
+  204:
+    description: "No Content - All revocations were successful"
+  400:
+    description: "Bad Request"
+  401:
+    description: "Unauthorized"
+  403:
+    description: "Forbidden"
+  404:
+    description: "Not Found"
+  429:
+    description: "Too Many Requests"
+  500:
+    description: "Internal Server Error"
+
 produces: &produces
   - "application/json"
   - "application/csv"
@@ -195,11 +228,11 @@ endpoints:
                       type: "string"
                       description: "user email"
                   filters:
-                    description: "List of emails with which licenses are associated"
+                    description: "Filters for lookup and filtering of licenses to revoke."
                     type: "array"
                     items:
                       type: "object"
-                      description: "filter"
+                      description: "Values provided to perform filtering against."
                       properties:
                         user_email:
                           description: "User email filter"
@@ -210,9 +243,9 @@ endpoints:
                           items:
                             type: "string"
                             description: "status of the license"
-        responses: *responses
+        responses: *bulk_revoke_responses
         x-amazon-apigateway-integration:
-          responses: *apigateway_responses
+          responses: *bulk_revoke_apigateway_responses
           httpMethod: "POST"
           type: "http"
           requestParameters:

diff --git a/api.yaml b/api.yaml
@@ -17,6 +17,21 @@ apigateway_responses:
     statusCode: "500"
   default:
     statusCode: "400"
+bulk_revoke_apigateway_responses:
+  "204":
+    statusCode: "204"
+  "401":
+    statusCode: "401"
+  "403":
+    statusCode: "403"
+  "404":
+    statusCode: "404"
+  "429":
+    statusCode: "429"
+  "500":
+    statusCode: "500"
+  default:
+    statusCode: "400"
 apigateway_responses_with_mapping_template_for_uuid:
   "200":
     statusCode: "200"
@@ -60,6 +75,21 @@ responses:
     description: Too Many Requests
   "500":
     description: Internal Server Error
+bulk_revoke_responses:
+  "204":
+    description: No Content - All revocations were successful
+  "400":
+    description: Bad Request
+  "401":
+    description: Unauthorized
+  "403":
+    description: Forbidden
+  "404":
+    description: Not Found
+  "429":
+    description: Too Many Requests
+  "500":
+    description: Internal Server Error
 produces:
   - application/json
   - application/csv
@@ -208,11 +238,11 @@ endpoints:
                       type: string
                       description: user email
                   filters:
-                    description: List of emails with which licenses are associated
+                    description: Filters for lookup and filtering of licenses to revoke.
                     type: array
                     items:
                       type: object
-                      description: filter
+                      description: Values provided to perform filtering against.
                       properties:
                         user_email:
                           description: User email filter
@@ -224,8 +254,8 @@ endpoints:
                             type: string
                             description: status of the license
         responses:
-          "200":
-            description: OK
+          "204":
+            description: No Content - All revocations were successful
           "400":
             description: Bad Request
           "401":
@@ -240,8 +270,8 @@ endpoints:
             description: Internal Server Error
         x-amazon-apigateway-integration:
           responses:
-            "200":
-              statusCode: "200"
+            "204":
+              statusCode: "204"
             "401":
               statusCode: "401"
             "403":