@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api OpenTrials API
@version 0.0.1
@endpoints 17
@toc search(3), trials(3), publications(1), conditions(1), organisations(1), persons(1), interventions(1), sources(1), fda_applications(2), documents(2), document_categories(1)

@group search
@endpoint GET /search
@optional {q: any, page: any, per_page: any}
@returns(200)

@endpoint GET /search/autocomplete/{in}
@required {in: any}
@optional {q: any, page: any, per_page: any}
@returns(200)

@endpoint GET /search/fda_documents
@optional {q: any, text: any, page: any, per_page: any}
@returns(200)

@endgroup

@group trials
@endpoint GET /trials/{id}
@required {id: any}
@returns(200)
@errors {404}

@endgroup

@group publications
@endpoint GET /publications/{id}
@required {id: any}
@returns(200)
@errors {404}

@endgroup

@group conditions
@endpoint GET /conditions/{id}
@required {id: any}
@returns(200)
@errors {404}

@endgroup

@group organisations
@endpoint GET /organisations/{id}
@required {id: any}
@returns(200)
@errors {404}

@endgroup

@group trials
@endpoint GET /trials/{id}/records
@required {id: any}
@returns(200)
@errors {404}

@endpoint GET /trials/{trialId}/records/{id}
@required {trialId: any, id: any}
@returns(200)
@errors {404}

@endgroup

@group persons
@endpoint GET /persons/{id}
@required {id: any}
@returns(200)
@errors {404}

@endgroup

@group interventions
@endpoint GET /interventions/{id}
@required {id: any}
@returns(200)
@errors {404}

@endgroup

@group sources
@endpoint GET /sources
@returns(200)

@endgroup

@group fda_applications
@endpoint GET /fda_applications
@optional {page: any, per_page: any}
@returns(200)

@endpoint GET /fda_applications/{id}
@required {id: any}
@returns(200)
@errors {404}

@endgroup

@group documents
@endpoint GET /documents
@optional {page: any, per_page: any}
@returns(200)

@endpoint GET /documents/{id}
@required {id: any}
@returns(200)
@errors {404}

@endgroup

@group document_categories
@endpoint GET /document_categories
@returns(200)

@endgroup

@end