Add examples for some components in the OpenAPI spec #42
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
… and ProjectAllocation
Ayedrian
added
enhancement
Mtze
requested changes
May 25, 2023
Co-authored-by: Matthias Linhuber <github@linhuber.org>
Co-authored-by: Matthias Linhuber <github@linhuber.org>
Ayedrian
commented
May 26, 2023
Mtze
approved these changes
May 30, 2023
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.
What changed: Some of the more complex and important components have examples now in accordance with their schemata: An example of a student object, skill object etc. were added.
Why the changes: We want to make the OpenAPI specification as easy to understand as possible, this will potentially help with testing and automatic code generation as well.
Testing steps: Not applicable.