Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

api_definition.definition.enabled is defined in the Classic API versioning document even if it should not be used #5288

Open
kaye-at-tyk opened this issue Aug 21, 2024 · 1 comment
Labels
enhancement Error Error in the docs

Comments

@kaye-at-tyk
Copy link

kaye-at-tyk commented Aug 21, 2024

Branch/Environment/Version

  • Tyk Documentation: v5.5 (Latest)
  • Tyk Gateway & Dashboard: v5.3.1 & v5.5.0
  • Note: api_definition.definition.enabled is populated by default (set to false) when creating Classic APIs using versions above

Relevant Document

https://site-dev.tykbeta.com/docs/tyk-gateway-api/api-definition-objects/

Describe the request

  • The document states that Classic APIs have an API-level configuration (api_definition.definition.enabled) to determine if it's using versioning or not:

There is also some API-level configuration for versioning, which is located in the definition section of the Tyk Classic API definition:
The definition section has the following fields:
...
enabled: toggle to enable or disable versioning

  • According to the answer in this Tyk StackOverflow question, api_definition.definition.enabled does not apply for Classic APIs
  • This has caused some confusion for a customer who tried to set api_definition.definition.enabled to true in their Classic API (reference: Zendesk ticket 19811)
  • As api_definition.definition.enabled should not be used for Classic APIs, this should either be omitted from the document, or should be marked as "not applicable"
@kaye-at-tyk kaye-at-tyk added enhancement Error Error in the docs labels Aug 21, 2024
@andyo-tyk
Copy link
Contributor

This will be addressed by #5293

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Error Error in the docs
Projects
None yet
Development

No branches or pull requests

2 participants