Feature/swagger #30
Merged
Feature/swagger #30
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
…ed details in one loop
…gger documentation
…ter not using safe-get
…reference a definition in reference fields
bjinwright
approved these changes
Apr 1, 2022
| @@ -32,9 +32,12 @@ def load_config_file(filename): | |||
| @click.option('--email', prompt=True, help='Default From Email') | |||
| @click.option('--bucket', prompt=True, help='S3 Bucket') | |||
| @click.option('--fauna_key', prompt=True, help='Fauna Key') | |||
| @click.option('--host', prompt=True, help='Host') | |||
There was a problem hiding this comment.
We should add the host option to the add-stage command.
There was a problem hiding this comment.
You can leave description in the init command.
| @@ -22,11 +22,15 @@ class StripePackage(Collection): | |||
| fields and functions to match your system. | |||
|
|
|||
| Read and detail views are naturally public. Write operations | |||
| requires authentication from admin group. | |||
| requires authentication from admin group. While it grealty | |||
There was a problem hiding this comment.
typo "grealty" should be greatly
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.
Changes
generate_swaggerfunction inpfunk/project.pyfor generating the swagger API docs from collections that use views.initnow acceptsdescriptionandhostargument to generate needed info for JSON config fileFiles changed
pfunk/project.pypfunk/cli.pypfunk/tests/test_projectDocumentation
The acquiring of swagger parts are as follows:
Response
Description
Acquired from the view's
get_querydocstringsStatus Code
Acquired from
response_classclass variable of a view. Error status_codes are also acquired from the class variablesOperation
HTTP Methods
Using the
http_methodsvariable in a viewSummary
Notated as follows: ({http_method}) -> {collection_name}
Description
Docstrings of the view
Path
Endpoint
Endpoint path of the function, you can it in the
urlmethod of a view.