fix(ocs): Minor improvements to the OCS OpenAPI documentation #13210
Conversation
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
| @@ -544,10 +544,14 @@ It is best to start with helper methods that are used multiple times like the `` | |||
| ... | |||
| } | |||
|
|
|||
| The return type for `DataResponse` required three arguments: status code, data and headers. See the constructor of `DataResponse` for details. | |||
There was a problem hiding this comment.
The other inheritors of Response should be explained as well. Can you maybe create a table for that?
There was a problem hiding this comment.
I added a table now with some of them and a note where to find that information. Maybe that's better than listing all of them extensively, also because others might be added later on. What do you think?
Signed-off-by: Jonas <[email protected]>
mejo-
force-pushed
the
fix/ocs_openapi_fixes
branch
from
e5072fc to
336106f
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.
No description provided.