Fix #6 add initial api specification #11
Merged
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
|
First full core API draft is now available. Please review it. OpenAPI editor can be used for easier visual inspection of the specification. |
Initial API specification for service modules has been made as well. |
- Added bound checking - Added format specifiers - Added required markings - Autoformated YAML files using Redhat formatter
|
Second draft of the APIs is now ready. Specification should be now pretty ready for prime time, but all comments are always welcome. There might be still some rough edges in this specification, but I think that minor faults can be smoothed out during development process. |
This was referenced Jun 1, 2021
- Can be used for recognizing, what action cloud module should take
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.
Short summary of changes in this pull request:
This pull request provides main core and module API definitions in OpenAPI format. OpenAPI format is very useful, since it enables automatic checking of incoming API calls and provides a way to generate documentation of the API automatically.
Short summary of important/debatable decisions and other notable choices made when working on the pull request:
OpenAPI was selected as a language for defining APIs in potku-console.
Other relevant information:
This is very big and important feature. API can be partly altered in the future, but it will be increasingly harder when code base grows. Because of that all discussion is especially welcome related to this PR.