Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
New REST API URLs #336
Spec for the current API can be seen here (you can test it with your local installation). I wanted to propose some changes to the URLs. It would help us when defining endpoints for post, put and delete.
After the above changes we are going to have sessions (similarly for speakers, tracks, etc.) at
Relevant doc on api best practices: https://github.com/WhiteHouse/api-standards#http-verbs
Edit: One more thing, flask-restplus already provides auto-doc feature to document APIs, so we would be using that.
This was referenced
May 17, 2016
referenced this issue
May 18, 2016
@rafalkowalski By "speakers, tracks, etc." I meant like the URL path
I do not follow. What do you mean?
Keep the session id absolute.
Reason: in the db, you just need to make sure the session table has the event id reference. Session ID is the primary key. If session id is relative, it will require more checking in code to determine if session id is part of the event. And there isn't any point to have a separate primary key and session id.
So far I like where this is going. Good job @shivamMg. Well thought out.