This repository has been archived by the owner on Jul 19, 2021. It is now read-only.
Add ARCHITECTURE.rst and module docstrings #6
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
Pull Request Test Coverage Report for Build 958559082
💛 - Coveralls |
RobbeSneyders
force-pushed
the
feature/architecture-docs
branch
from
8bbd30d
to
7bd65cb
Compare
Ruwann
reviewed
Jun 22, 2021
There was a problem hiding this comment.
AFAICT, the architecture seems logical to me. Haven't been able to check everything, so I'll continue when I have tried it out.
Minor comment on the diagram is that the 1:n are not super clear, I would perhaps use a similar notation to UML diagrams by indicating the cardinality at both ends of the relationship.
| @@ -1 +1,16 @@ | |||
| """ | |||
| This module defines an Connexion APIs. A connexion API takes in an OpenAPI specification and | |||
| @@ -1,3 +1,7 @@ | |||
| """ | |||
| This module defines a FlaskApp, a Connexion application to wrap an AioHttp application. | |||
| @@ -1,4 +1,7 @@ | |||
| # Decorators to change the return type of endpoints | |||
| """ | |||
| This module defines an view function decorator to validate its responses. | |||
There was a problem hiding this comment.
"an view function" --> "a view function"
| to framework specific responses. | ||
|
|
||
| .. _Flask blueprint: https://flask.palletsprojects.com/en/2.0.x/blueprints/ | ||
| .. _OpenAPI operation: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#operation-object |
There was a problem hiding this comment.
Perhaps provide a link to both swagger 2 and OpenAPI 3 operation objects to make it clear both versions are supported?
https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#operationObject
|
Closing as this has been merged upstream. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR adds high level documentation for Connexion
ARCHITECTURE.rstfile with a diagram of the high level architecture and a short explanation of the main componentsSince documentation on the architecture and internals was only sparsely available, I had to build my understanding mostly by going through the code. This wasn't always straightforward so let me know if you think I misinterpreted / misrepresented something, or if some descriptions aren't clear.