Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

webapi-spec: content of put/post for workspaces #209

Merged
merged 2 commits into from
Aug 14, 2022
Merged

webapi-spec: content of put/post for workspaces #209

merged 2 commits into from
Aug 14, 2022

Conversation

joschrew
Copy link
Contributor

@joschrew joschrew commented Jul 6, 2022

In my opinion the content/body for post and put a workspace have to be the same. But I'm not 100 % sure how to define them. I read this https://swagger.io/docs/specification/describing-request-body/file-upload/ and that: https://stackoverflow.com/questions/14455408/how-to-post-files-in-swagger-openapi.
I want to use WorkspaceRequest defined in component.schema, but I think the json-part should be left out. So this PR is what I came up with.

@joschrew
Copy link
Contributor Author

joschrew commented Jul 7, 2022

I am not really sure if i have done it right but i definitely think the bodies of put and post have to be equal. At least someone has to convince me that I am wrong.

@joschrew joschrew requested a review from kba July 7, 2022 11:40
openapi.yml Outdated Show resolved Hide resolved
@joschrew
Copy link
Contributor Author

joschrew commented Jul 8, 2022

Ok, thank you. I now updatet the PR to what I think it should look like regarding the post end put request. As you said I (really) would prefer a simple file upload for both methods without additional json. Thanks for pointing out how to view the api online, it helped me.

@kba kba merged commit 59e5e86 into OCR-D:master Aug 14, 2022
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.

2 participants