Skip to content

Remove Description from specification translation - #1758

Open
dgenezini wants to merge 2 commits into
masterfrom
dgenezini/lang-remove-desc
Open

Remove Description from specification translation#1758
dgenezini wants to merge 2 commits into
masterfrom
dgenezini/lang-remove-desc

Conversation

@dgenezini

Copy link
Copy Markdown
Contributor

Problem

When translating a specification, the API request and response included a Description field. This field is no longer used, so it should be removed from the documentation and examples.

Solution

Removed Description from the specification translation endpoints in both Postman collections and the API spec:

  • PostmanCollections/VTEX - Catalog API.json
    • Removed Description from the GET specification translation example body
    • Removed Description from the response validation JSON schema
    • Removed Description from the PUT update translation example bodies
  • VTEX - Catalog API.json
    • Removed Description from the GET response schema and example
    • Removed Description from the PUT update request schema and example

Description no longer part of specification language endpoints; drop field from examples, response schemas, and Postman request bodies and validation.
@vtex-pr-sentinel

Copy link
Copy Markdown

🛡️ SDD Check — action required

I couldn't detect an SDD in this PR. Please check one option below (requires write access to the repo):

  • SDD lives in another PR — paste the SDD PR URL here:
  • This PR doesn't need an SDD
  • SDD applies, but I'm not adopting it in this PR

@github-actions

Copy link
Copy Markdown

OpenAPI Preview

Preview the changed specs:

Links point to commit 34568d5. They will update on each new push to this PR.

@github-actions

Copy link
Copy Markdown

Thanks for your contribution. The .json file will be checked now with Spectral.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant