Adds swagger API documentation #180
Conversation
| @@ -24,6 +24,19 @@ | |||
| from abe.helper_functions.sub_event_helpers import create_sub_event, update_sub_event, sub_event_to_full, access_sub_event, find_recurrence_end | |||
| from abe.helper_functions.query_helpers import get_to_event_search, event_query | |||
|
|
|||
| api = Namespace('events', description='Events related operations') | |||
|
|
|||
| event_model = api.model('Events_Model', { | |||
There was a problem hiding this comment.
Add a comment here and to Events, that when one is updated the other should be too.
There was a problem hiding this comment.
When you say "to Events", are you suggesting the document model? Or the class just below this?
There was a problem hiding this comment.
If I understand correctly, this statement needs to be manually (as we discussed) kept in sync with what I now see is event_documents.Event, so I was proposing a comment here and at the definition of event_documents.Event.
README.md
Outdated
| | GET | retrieve label with name "clubs" | | ||
| | PUT | update label with name "clubs" | | ||
| | DELETE | delete label with name "clubs" | | ||
| Interactive API documentation can be found at`/swagger/`, e.g. for local develepment: <http://127.0.0.1:3000/swagger/>. |
There was a problem hiding this comment.
"develepment" → "development"
abe/resource_models/ics_resources.py
Outdated
| @@ -22,12 +22,20 @@ | |||
| from abe.helper_functions.query_helpers import get_to_event_search, event_query | |||
| from abe.helper_functions.ics_helpers import mongo_to_ics, extract_ics | |||
|
|
|||
| api = Namespace('ics', description='ICS feeds') | |||
|
|
|||
| ics_model = api.model("ICS_Model", { | |||
There was a problem hiding this comment.
See comment re Events_Model.
| @@ -21,6 +21,18 @@ | |||
| from abe.helper_functions.converting_helpers import mongo_to_dict, request_to_dict | |||
| from abe.helper_functions.query_helpers import multi_search | |||
|
|
|||
| api = Namespace('labels', description='Label related operations') | |||
|
|
|||
| label_model = api.model("Label_Model", { | |||
There was a problem hiding this comment.
See comment re Events_Model.
| @@ -41,7 +41,13 @@ | |||
| if os.environ.get('HSTS_ENABLED'): | |||
| SSLify(app, age=10, skips=['.well-known/acme-challenge/']) | |||
|
|
|||
| api = Api(app) | |||
|
|
|||
| @app.route('/') # For the splash to work, needs to be declared before API | |||
There was a problem hiding this comment.
👍 recording motivation for placement
| @@ -24,6 +24,20 @@ | |||
| from abe.helper_functions.sub_event_helpers import create_sub_event, update_sub_event, sub_event_to_full, access_sub_event, find_recurrence_end | |||
| from abe.helper_functions.query_helpers import get_to_event_search, event_query | |||
|
|
|||
| api = Namespace('events', description='Events related operations') | |||
|
|
|||
| #This should be kept in sync with the document model, which drives the format | |||
There was a problem hiding this comment.
This introduces a flake8 error, but I think it's time to get this PR in anyway; I'll address it in the next change.
Resolves #133 , and provides the groundwork for #142.
The documentation still doesn't have as much content as would be nice, but it's quite serviceable, and much more useful than the current state.
Instructions for how to add more documentation to swagger will be added to the abe developer cookbook, which should roll over to the wiki in the future.
Could easily change the documentation url from
/swagger/or the API version from0.1if there are better alternatives.#175 will make this more discoverable as well.