Unable to update API with authentication info

[jeffesp]

Branch/Environment/Version

Tyk version 5.5 using the Gateway API

Relevant Document

https://tyk.io/docs/getting-started/using-oas-definitions/update-an-oas-api/#step-2-update-the-tyk-oas-api

Describe the error

When I try to update the API following the instructions in "Tutorial 2" I get the following error when making the PUT request to the API (PUT to /tyk/apis/oas/<api-id>).

{
  "status": "error",
  "message": "(root): Additional property basic-config-and-security/security is not allowed"
}

It seems like the "diff" that includes the basic-config-and-security/security change is wrong?

I also tried just adding a security element as defined in the OAS docs, but that gave me this error, with nothing else in the gateway logs:

{
  "status": "error",
  "message": "request malformed"
}

A request without either of the above but having security defined in the components/securitySchemes and the x-tyk-api-gateway/server/authentication sections does seem to work, but I am not sure that it should.

Example of securitySchemes:

  "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }

Example of x-tky-api-gateway auth definition:

  "server": {
      "listenPath": {
        "value": "/a-service/",
        "strip": true
      },
      "authentication": {
        "enabled": true,
        "securitySchemes": {
          "bearerAuth": {
            "enabled": true
          }
        }
      }
    }

Should what I have done work? Can the docs be updated if so?

Screenshots/Video

Additional context

[jeffesp]

This page seems to give more context to the whole situation, but seems to indicate that the security element in the OAS should work, which I do not see.

[jeffesp]

Just figured out my issue - it was a problem with my security section. So I would summarize the issue here as you should not be indicating basic-config-and-security - it's just security.