InterNetX / domainrobot-api

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

Soa definition incorrect #11

Closed agowa closed 2 years ago

agowa commented 3 years ago

The soa definition in the documentation is wrong.

    "Soa" : {
      "type" : "object",
      "required" : [ "email" ],
      "properties" : {
        "refresh" : {
          "type" : "integer",
          "format" : "int64",
          "description" : "The seconds after the secondary should refresh the zone data"
        },
        "retry" : {
          "type" : "integer",
          "format" : "int64",
          "description" : "The seconds after the secondary should retry the zone data after the refresh has been timeouts"
        },
        "expire" : {
          "type" : "integer",
          "format" : "int64",
          "description" : "The seconds after the zone data will not be delievered, if the zone could not be reached on the master."
        },
        "ttl" : {
          "type" : "integer",
          "format" : "int64"
        },
        "email" : {
          "type" : "string",
          "description" : "The email address of the responsible of the zone"
        }
      }

It should have:

      "required" : [ "refresh", "retry", "expire", "ttl" ],

Apparently "email" is the only attribute that is NOT required.

When trying to create a new zone, this error is returned by the api:


{"stid":"20210114-app1-143532","messages":[{"text":"Ungueltiger Wert für Refresh.","code":"MSG02005"},{"text":"Ungueltiger Retry-Wert.","code":"MSG02007"},{"text":"Ungueltiger Expire-Wert.","code":"MSG02008"},{"text":"Ungueltige SOA-TTL.","objects":[{"type":"soa/ttl"}],"code":"EF02004","status":"ERROR"}],"status":{"code":"E0201","text":"Zone konnte nicht in Nameserver eingetragen werden.","type":"ERROR"},"object":{"type":"Zone","value":"dev.FOOBAR.FOO"}}
TamaoX8 commented 2 years ago

The values SOA- refresh, retry, expire, ttl are no longer required. But note that out system will replace missing values for "refresh", "retry", "expire", "ttl" in the request with default values.

As for the "email concerns": Our system will not give an error message if the email is missing, but we strongly recommend setting the "email".