Skip to content

refactor!: add missing required params#571

Merged
Sönke Behrendt (theSoenke) merged 4 commits intomasterfrom
add-required-params
Apr 23, 2024
Merged

refactor!: add missing required params#571
Sönke Behrendt (theSoenke) merged 4 commits intomasterfrom
add-required-params

Conversation

@theSoenke
Copy link
Copy Markdown
Collaborator

@theSoenke Sönke Behrendt (theSoenke) commented Apr 16, 2024

Improve documentation of required params. This will be a breaking change for some endpoints in the libraries and will be released in a new major version. It's not a breaking change for the REST API itself as these param were already required before and returned a 422 in case they were missing

The following endpoints now have additional required parameters:
authorizations#create - note is required
blacklisted_keys#create - name is required
branches#create - name is required
distributions#create - name, project_id are required
figma_attachements#create - url is required
glossaries#create - name is required
glossary_term_translations#create - locale_code, content are required
glossary_terms#create - term is required
invitations#create - email, role are required
jobs#create - name is required
keys#create - name is required
locales#create - name, code are required
orders#create - name, lsp are required
projects#create - name is required
screenshot_markers#create - key_id is required
spaces#create - name is required
styleguides#create - title is required
tags#create - name is required
teams#add_project - id is required
team#add_space - id is required
teams#add_user - id is required
teams#create - name is required
translations#create - locale_id, key_id are required
uploads#create - file, file_format, locale_id are required
variables#create - name is required
webhooks#create - callback_url is required

@theSoenke Sönke Behrendt (theSoenke) changed the title Add missing required params BREAKING CHANGE: Add missing required params Apr 16, 2024
@theSoenke Sönke Behrendt (theSoenke) changed the title BREAKING CHANGE: Add missing required params feat: add missing required params Apr 16, 2024
@theSoenke Sönke Behrendt (theSoenke) force-pushed the add-required-params branch 8 times, most recently from 1ee4b80 to dfd983c Compare April 19, 2024 09:07
@theSoenke Sönke Behrendt (theSoenke) changed the title feat: add missing required params breaking change!: add missing required params Apr 19, 2024
@theSoenke Sönke Behrendt (theSoenke) changed the title breaking change!: add missing required params refactor!: add missing required params Apr 19, 2024
@theSoenke Sönke Behrendt (theSoenke) force-pushed the add-required-params branch 2 times, most recently from cdb0251 to 359db28 Compare April 19, 2024 09:14
@theSoenke Sönke Behrendt (theSoenke) marked this pull request as ready for review April 19, 2024 09:42
Comment thread paths/comment_reactions/destroy.yaml Outdated
Comment thread paths/figma_attachment_keys/destroy.yaml
@theSoenke Sönke Behrendt (theSoenke) force-pushed the add-required-params branch 4 times, most recently from b4db842 to 622eadc Compare April 22, 2024 07:19
Comment thread paths/distributions/create.yaml
Comment thread paths/orders/create.yaml
Comment thread paths/translations/create.yaml Outdated
Comment thread openapi-generator/templates/go/README.mustache
Comment thread paths/key_links/batch_destroy.yaml
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.

3 participants