-
Notifications
You must be signed in to change notification settings - Fork 0
Add ARCHITECTURE.rst and module docstrings #6
Conversation
Pull Request Test Coverage Report for Build 958559082
💛 - Coveralls |
8bbd30d
to
7bd65cb
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo: "an Connexion APIs."
@@ -1,3 +1,7 @@ | |||
""" | |||
This module defines a FlaskApp, a Connexion application to wrap an AioHttp application. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"to wrap a Flask 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
This PR adds high level documentation for Connexion
ARCHITECTURE.rst
file 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.