tyk-docs icon indicating copy to clipboard operation
tyk-docs copied to clipboard

OAS Versioning page does not actually tell me how to do it

Open jeffesp opened this issue 1 year ago • 1 comments

Branch/Environment/Version

N/A

Relevant Document

https://tyk.io/docs/getting-started/key-concepts/oas-versioning/

Describe the error

There is not really an error, but the page does not actually tell me how to configure versioning with the API. It gives me a sample of defining a "Base API" and in that sample, assumes that I have another version of the API that I want to reference as a Child. In actual use, I am going to be:

  1. defining a Base API
  2. then defining a Child,
  3. then updating the Base to include the Child.

I have no idea how to do this from these docs. When I went to the API docs to look at requests and their parameters, I am still left wondering, as the PATCH request to /tyk/apis/oas/{api_id}/ does not mention that you can update versioning. So I think what I am left to try is:

  1. defining a Base API
  2. then defining a Child,
  3. GET the full API object for the Base
  4. Add the Child in the versioning info
  5. PUT that object back to the gateway so it will have a Child version.

But I have no idea if this will work, or when it does not, what I could possibly look at to see what is wrong.

Screenshots/Video

Additional context

jeffesp avatar Sep 27 '24 14:09 jeffesp