InterNetX / domainrobot-api

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

Wrong types for "job" in PollMessage #3

Closed patrickhilker closed 5 years ago

patrickhilker commented 5 years ago

In the DomainRobot Swagger file, the field "job" in the PollMessage object has the data type "string", but this does not match the response coming from the API. In the response "job" is an object with the keys "created", "updated", "status", "execution" and "id".

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

mortensen commented 5 years ago

Hi @patrickhilker

The bug in the json file is fixed by today and will be deployed likely by next week. The corrected PollMessage object will look like following:

"PollMessage" : {
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "integer",
          "format" : "int64",
          "description" : "The message id."
        },
        "owner" : {
          "description" : "The owner of the message.",
          "originalRef" : "BasicUser",
          "$ref" : "#/definitions/BasicUser"
        },
        "job" : {
          "description" : "The job data. Available if the message is a job message",
          "originalRef" : "WorkflowSpool",
          "$ref" : "#/definitions/WorkflowSpool"
        },
        "notify" : {
          "description" : "The notification data. Available if the message is a notification message",
          "originalRef" : "NotifyMessage",
          "$ref" : "#/definitions/NotifyMessage"
        },
        "stid" : {
          "type" : "string",
          "description" : "The server transaction id."
        },
        "ctid" : {
          "type" : "string",
          "description" : "the custom transaction id."
        },
        "messages" : {
          "type" : "array",
          "description" : "The general localized messages.",
          "items" : {
            "originalRef" : "Message",
            "$ref" : "#/definitions/Message"
          }
        },
        "flags" : {
          "type" : "string",
          "description" : "Optional message flags."
        },
        "created" : {
          "type" : "string",
          "format" : "date-time",
          "description" : "The created date."
        },
        "object" : {
          "description" : "The object of the job or notify.",
          "originalRef" : "ResponseObject",
          "$ref" : "#/definitions/ResponseObject"
        }
      }
    }
patrickhilker commented 5 years ago

Perfect, thanks in advance! 😊

mortensen commented 5 years ago

Changes are pushed to master. Ticket closed.