fix: only add mutually exclusive description if argument is a lookup argument set (#81)

* fix: only add mutually exclusive description if argument is a lookup argument set

* chore: add plain_text post which does not contain the mutually exclusive description

Author: ikadix

examples/core_api/base.rb

@@ -18,7 +18,7 @@ class Base < Apia::API
       add "time", "Allows time telling functions"
     end
 
-    routes do
+    routes do # rubocop:disable Metrics/BlockLength
       schema
 
       get "time_formatting/incredibly/super/duper/long/format", controller: Controllers::TimeController,
@@ -27,6 +27,7 @@ class Base < Apia::API
       post "example/format_multiple", controller: Controllers::TimeController, endpoint: :format_multiple
 
       get "plain_text", endpoint: Endpoints::PlainTextEndpoint
+      post "plain_text", endpoint: Endpoints::PlainTextEndpoint
 
       get "paginated", endpoint: Endpoints::PaginatedEndpoint
 

lib/apia/open_api/objects/schema.rb

@@ -80,8 +80,10 @@ def generate_child_schemas
             @children = @definition.fields.values
           elsif @definition.type.argument_set?
             @children = @definition.type.klass.definition.arguments.values
-            @schema[:description] ||=
-              "All '#{@definition.name}[]' params are mutually exclusive, only one can be provided."
+            if @definition.type.klass.ancestors.include?(Apia::LookupArgumentSet)
+              @schema[:description] ||=
+                "All '#{@definition.name}[]' params are mutually exclusive, only one can be provided."
+            end
           elsif @definition.type.object?
             @children = @definition.type.klass.definition.fields.values
           elsif enum_definition?

spec/support/fixtures/openapi.json

@@ -308,6 +308,45 @@
             "$ref": "#/components/responses/APIAuthenticator403Response"
           }
         }
+      },
+      "post": {
+        "operationId": "post:plain_text",
+        "summary": "Plain Text Endpoint",
+        "description": "Return a plain text response",
+        "tags": [
+          "Core"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "properties": {
+                  "disk_template_options": {
+                    "type": "array",
+                    "items": {
+                      "$ref": "#/components/schemas/KeyValue"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Return a plain text response",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          },
+          "403": {
+            "$ref": "#/components/responses/APIAuthenticator403Response"
+          }
+        }
       }
     },
     "/paginated": {
@@ -1098,6 +1137,20 @@
           }
         }
       },
+      "KeyValue": {
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string"
+          },
+          "value": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "key"
+        ]
+      },
       "PaginationObject": {
         "type": "object",
         "properties": {