junction
junction copied to clipboard
Add proposal API
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
andproposal_type
contains the name and notid
. -
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.