fix: Avoid oneOf usage in Open API 2.0 spec (chatwoot#8819)

Small fixes to make spec adhere to swagger 2.0
DigitalTolk · Jan 31, 2024 · 53d42b1 · 53d42b1
1 parent 17cb788
commit 53d42b1
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 47 deletions.
diff --git a/swagger/definitions/request/public/message/update_payload.yml b/swagger/definitions/request/public/message/update_payload.yml
@@ -2,19 +2,5 @@
 type: object
 properties:
   submitted_values:
-    oneOf:
-      - type: object
-        description: Replies to the Bot Message Types
-        properties:
-          csat_survey_response:
-            type: object
-            description: CSAT Survey Response if original message is CSAT Survey
-            properties:
-              rating:
-                type: integer
-                description: CSAT Rating
-                example: 5
-              feedback_message:
-                type: string
-                description: CSAT Comment
-                example: 'Great'
+    type: object
+    description: Replies to the Bot Message Types
diff --git a/swagger/parameters/index.yml b/swagger/parameters/index.yml
@@ -51,3 +51,6 @@ public_inbox_identifier:
 
 public_contact_identifier:
   $ref: ./public/contact_identifier.yml
+
+portal_id:
+  $ref: ./portal_id.yml
diff --git a/swagger/paths/application/contacts/filter.yml b/swagger/paths/application/contacts/filter.yml
@@ -36,7 +36,7 @@ parameters:
               query_operator:
                 type: string
                 description: query operator name
-              enum: [ AND, OR ]
+                enum: [ AND, OR ]
           example:
             - attribute_key: 'name'
               filter_operator: 'equal_to'

diff --git a/swagger/swagger.json b/swagger/swagger.json
@@ -2154,12 +2154,12 @@
                       },
                       "query_operator": {
                         "type": "string",
-                        "description": "query operator name"
-                      },
-                      "enum": [
-                        "AND",
-                        "OR"
-                      ]
+                        "description": "query operator name",
+                        "enum": [
+                          "AND",
+                          "OR"
+                        ]
+                      }
                     }
                   },
                   "example": [
@@ -6746,30 +6746,8 @@
       "type": "object",
       "properties": {
         "submitted_values": {
-          "oneOf": [
-            {
-              "type": "object",
-              "description": "Replies to the Bot Message Types",
-              "properties": {
-                "csat_survey_response": {
-                  "type": "object",
-                  "description": "CSAT Survey Response if original message is CSAT Survey",
-                  "properties": {
-                    "rating": {
-                      "type": "integer",
-                      "description": "CSAT Rating",
-                      "example": 5
-                    },
-                    "feedback_message": {
-                      "type": "string",
-                      "description": "CSAT Comment",
-                      "example": "Great"
-                    }
-                  }
-                }
-              }
-            }
-          ]
+          "type": "object",
+          "description": "Replies to the Bot Message Types"
         }
       }
     },
@@ -7280,6 +7258,13 @@
       "type": "string",
       "required": true,
       "description": "The source id of contact obtained on contact create"
+    },
+    "portal_id": {
+      "in": "path",
+      "name": "portal_id",
+      "type": "integer",
+      "required": true,
+      "description": "The numeric ID of the portal"
     }
   },
   "x-tagGroups": [