Supported endpoints with the same tag as deprecated endpoints are also marked deprecated #1980
laurel
started this conversation in
Bugs & Feedback
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
In a different JSON file, similar endpoints (whose paths are different than the ones above) are marked with
"deprecated": true, and they have the same tag ("Parsers CRUD API") as the supported endpoints in the first file.The issue resolved after we changed the tags in the second file to ""Parsers CRUD API (Deprecated)" so they no longer match the tags in the first file:
https://lucidworks-docs-7272-fix-deprecations.mintlify.app/api-reference/parsers-crud-api/list-all-parsers
An endpoint should only be marked "Deprecated" when its operation definition contains
"deprecated": true; the deprecation should not be applied to all operations with the same tag. The OpenAPI standard specifies that thedeprecatedkey applies to individual operations: https://spec.openapis.org/oas/v3.2.0.html?utm_source=chatgpt.com#:~:text=the%20expected%20responses.-,deprecated,from%20usage%20of%20the%20declared%20operation.%20Default%20value%20is%20false.,-securityThus we should be able to mark an individual operation as deprecated without having all of the operations in its group marked deprecated.
Beta Was this translation helpful? Give feedback.
All reactions