Issues with using the specs for code generation or validation about adyen-openapi HOT 2 CLOSED

Hi @geoah, thank you very much for your extensive feedback! We've just added a more detailed specification for additionalData and we are also exploring better ways for displaying it.

1. You are right, [itemNr] should be replaced with a specific number. The problem here is that this is not a pure array, so this was the only way we saw for describing such elements in a spec. Please let me know if we can do this differently and make it more usable for you.

2. We will look into this in future updates to the spec.

3 and 4. We didn't describe them before, but it's definitely on our list.

5. Thanks, we'll fix it. But also please keep in mind that everything in additionalData is a string.

6. We are planning to add more information about formats in the future.

7. This is done so because everything is a string in additionalData. Although we can use enums in this case, if this would help.

from adyen-openapi.

With the updated specs today, here is the latest status:

1, 2, 5, 7 - we moved all additionalData-related models from anyOf to x-anyOf. This way we can still represent data in API Explorer and have it in the specification files for reference purposes, but also we don't expect any strict validation/generation happening with these models.

additionalData is now specified like this:

               "additionalData" : {
                  "additionalProperties" : {
                     "type" : "string"
                  },
                  "x-anyOf" : [
                         ...
                  ],
                  "description" : "...",
                  "type" : "object"
               },

Hope this solves all the potential problems with it.

3. We've added securitySchemas:

      "securitySchemes" : {
         "ApiKeyAuth" : {
            "in" : "header",
            "name" : "X-API-Key",
            "type" : "apiKey"
         },
         "BasicAuth" : {
            "scheme" : "basic",
            "type" : "http"
         }
      },

4. I've created a separate issue for this: #19

5. I've created a separate issue for this: #20

@geoah many thanks again for reporting all this. For now, I'm closing this one, but please feel free to re-open or create more, in case you see more room for improving our OpenAPI files.

from adyen-openapi.