Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

6-api-documentation #15

Merged
merged 5 commits into from
Aug 8, 2019
Merged

6-api-documentation #15

merged 5 commits into from
Aug 8, 2019

Conversation

z6wdc
Copy link
Member

@z6wdc z6wdc commented Aug 5, 2019

I have followed these two documents to reorg our api and generate automatically documentation.
And we can see our documentation by our end point URL.
https://flask-restplus.readthedocs.io/en/stable/scaling.html
https://flask-restplus.readthedocs.io/en/stable/swagger.html

This PR also included a /member api that will return the member's json file.
But I have not connected with our SQL.

I will create another PR for connecting our SQL and write a model for dealing with json file.

@z6wdc z6wdc added the WIP work in process label Aug 5, 2019
@z6wdc z6wdc requested review from bkno21427 and dwi2 August 5, 2019 10:53
@z6wdc z6wdc self-assigned this Aug 5, 2019
@z6wdc z6wdc requested a review from AsukaCHikaru August 6, 2019 01:35
@z6wdc z6wdc added ready for review and removed WIP work in process labels Aug 6, 2019

# TODO:
# We should create a package and move this into that package
@app.route('/photo', methods=['GET'])
Copy link
Contributor

@dwi2 dwi2 Aug 6, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This means after this patch, /photo is no longer working.
Can we also add an apis/photo.py to maintain compatibility?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I will add it.

Copy link
Member Author

@z6wdc z6wdc Aug 6, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added by this commit 971363c

@z6wdc z6wdc added WIP work in process ready for review and removed ready for review WIP work in process labels Aug 6, 2019
Copy link

@AsukaCHikaru AsukaCHikaru left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Copy link
Contributor

@dwi2 dwi2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@z6wdc z6wdc merged commit 0dd65d5 into project-yori:master Aug 8, 2019
@z6wdc z6wdc deleted the 6-api-document branch August 8, 2019 01:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants