Remove Description from specification translation - #1758
Open
dgenezini wants to merge 2 commits into
Open
Conversation
Description no longer part of specification language endpoints; drop field from examples, response schemas, and Postman request bodies and validation.
🛡️ SDD Check — action requiredI couldn't detect an SDD in this PR. Please check one option below (requires write access to the repo):
|
OpenAPI PreviewPreview the changed specs:
|
|
Thanks for your contribution. The .json file will be checked now with Spectral. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
When translating a specification, the API request and response included a
Descriptionfield. This field is no longer used, so it should be removed from the documentation and examples.Solution
Removed
Descriptionfrom the specification translation endpoints in both Postman collections and the API spec:Descriptionfrom the GET specification translation example bodyDescriptionfrom the response validation JSON schemaDescriptionfrom the PUT update translation example bodiesDescriptionfrom the GET response schema and exampleDescriptionfrom the PUT update request schema and example