ALFREDAPI-565: Update swagger doc for /upload metadata #237
Conversation
This file contains 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
RVanhuysseXenit
requested changes
Jan 6, 2025
docs/swagger-ui/swagger.json
Outdated
| @@ -636,11 +636,14 @@ | |||
| "200": { | |||
| "description": "Success", | |||
| "schema": { | |||
| "$ref": "#/definitions/NodeInfo" | |||
| "$ref": "#/definitions/MetadataChanges" | |||
There was a problem hiding this comment.
This is incorrect, you'd need to change the type property in the metadata entry of parameters.
The returntype is unchanged.
There was a problem hiding this comment.
Oof, big mistake, indeed.
However, it seems to be impossible to use complex types (from https://swagger.io/docs/specification/v2_0/describing-parameters/#form-parameters):
Form parameters are defined as in: formData. They can only be primitives (strings, numbers, booleans) or arrays of primitives (meaning you cannot use a $ref as the items value).
I will roll back this change, of course.
WimCrols
force-pushed
the
ALFREDAPI-565_multipartformdatacontenttype
branch
from
ce26f36 to
0da1a6d
Compare
|
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.
Fixes https://xenitsupport.jira.com/browse/ALFREDAPI-565
Breaking changes include adding, changing or removing endpoints and/or JSON objects used in requests and responses.
@ExceptionHandlerin the webscript classes?this.prefix avoided?See README.md for full explanation.