InterNetX / domainrobot-api

Swagger documentation for different APIs powered by InterNetX GmbH.
MIT License
18 stars 9 forks source link

Missing "items" in type array #4

Closed patrickhilker closed 5 years ago

patrickhilker commented 5 years ago

https://github.com/InterNetX/internetx-swagger-files/blob/b7bece8af7114bdd64591741a600a79e477dd6ed/src/domainrobot.json#L225

The Swagger documentation states that the "items" keyword is required in an array. It is missing in several new lines introduced in todays commit.

https://swagger.io/docs/specification/data-models/data-types/#array

mortensen commented 5 years ago

Hi @patrickhilker

Thanks for your hint. I fixed this issue. The "keys" array is an optional list of strings, which can be added to the url to add additional output to some tasks.

Part of the changes look like following:

"/backupMx" : {
      "post" : {
        "tags" : [ "backupMx Tasks" ],
        "summary" : "Create BackupMx",
        "description" : "Create a new backup mx.",
        "operationId" : "backupMxCreate",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "X-Domainrobot-PIN",
          "in" : "header",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "X-Domainrobot-Owner-User",
          "in" : "header",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "X-Domainrobot-Owner-Context",
          "in" : "header",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "X-Domainrobot-Demo",
          "in" : "header",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "X-Domainrobot-SessionId",
          "in" : "header",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "X-Domainrobot-Context",
          "in" : "header",
          "required" : false,
          "type" : "string"
        }, {
          "name" : "X-Domainrobot-WS",
          "in" : "header",
          "required" : false,
          "type" : "string"
        }, {
          "in" : "body",
          "name" : "body",
          "description" : "backupMx",
          "required" : false,
          "schema" : {
            "originalRef" : "BackupMx",
            "$ref" : "#/definitions/BackupMx"
          }
        }, {
          "name" : "keys",
          "in" : "query",
          "description" : "If the dns should be provisioned if available.",
          "required" : false,
          "type" : "array",
          "items" : {
            "type" : "string",
            "example" : "?keys[]=dnsProvisioning"
          },
          "collectionFormat" : "multi",
          "x-example" : "?keys[]=dnsProvisioning"
        } ],
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "schema" : {
              "originalRef" : "JsonResponseDataJsonNoData",
              "$ref" : "#/definitions/JsonResponseDataJsonNoData"
            },
            "responseSchema" : {
              "originalRef" : "JsonResponseDataJsonNoData",
              "$ref" : "#/definitions/JsonResponseDataJsonNoData"
            }
          }
        }
      }
    }

This ticket will also be deployed likely by next week.

Regards

Frederik

patrickhilker commented 5 years ago

😊

mortensen commented 5 years ago

Changes are pushed to master. Ticket closed.