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

Add proposal API #462

Open
kracekumar opened this issue Jul 2, 2016 · 0 comments · May be fixed by #473
Open

Add proposal API #462

kracekumar opened this issue Jul 2, 2016 · 0 comments · May be fixed by #473

Comments

@kracekumar
Copy link
Member

Junction doesn't have API to expose proposals public data. There are APIs for conference, schedule, venue etc ... Junction needs to have API for the proposals.

Slug: /api/v1/proposals?conference_name=conference_name

API returns 20 proposals at a time with the total count.

{'count': 166,
'data': [{}, {}]}
  • count contains a total number of items.
  • data contains list of proposals details.
  • Proposal details should contain following details id, proposal_section, proposal_type, author, title, prerequisites, content_urls, speaker_info, speaker_links, comments.
  • proposal_section and proposal_type contains the name and not id.
  • author contains the username.
  • comments should return only public comments.
  • The Client should recursively fetch the data til the count becomes less than limit i.e 20.
  • API can give out a maximum of 20 items at any point.
  • After fetching first set of records, client needs to set offset in next request. Sample: /api/v1/proposals?conference_name=conference_name&offset=20 and /api/v1/proposals?conference_name=conference_name&offset=20

Server Notes:

  • The Server should load all the proposals and comments in the single DB request.

Note: Ignore proposals in draft and deleted state.

@ChillarAnand ChillarAnand self-assigned this Jul 5, 2016
@ChillarAnand ChillarAnand linked a pull request Jul 7, 2016 that will close this issue
@ChillarAnand ChillarAnand added ready and removed ready labels Jul 20, 2016
@palnabarun palnabarun added this to the Enhancements milestone Mar 20, 2020
@pradyunsg pradyunsg removed the review label Mar 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants