@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api WikiPathways Webservices
@base https://webservice.wikipathways.org/
@version 1.0
@auth ApiKey auth in query
@common_fields {format: any}
@endpoints 26
@hint download_for_search
@toc listOrganisms(1), listPathways(1), getPathway(1), getPathwayInfo(1), getPathwayHistory(1), getRecentChanges(1), login(1), updatePathway(1), createPathway(1), findPathwaysByText(1), findPathwaysByXref(1), removeCurationTag(1), saveCurationTag(1), getCurationTags(1), getCurationTagsByName(1), getCurationTagHistory(1), getColoredPathway(1), findInteractions(1), getXrefList(1), findPathwaysByLiterature(1), saveOntologyTag(1), removeOntologyTag(1), getOntologyTermsByPathway(1), getPathwaysByOntologyTerm(1), getPathwaysByParentOntologyTerm(1), getUserByOrcid(1)

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

@endgroup

@group listPathways
@endpoint GET /listPathways
@optional {organism: any}
@returns(200)

@endgroup

@group getPathway
@endpoint GET /getPathway
@required {pwId: any}
@optional {revision: any}
@returns(200)

@endgroup

@group getPathwayInfo
@endpoint GET /getPathwayInfo
@required {pwId: any}
@returns(200)

@endgroup

@group getPathwayHistory
@endpoint GET /getPathwayHistory
@required {pwId: any, timestamp: any}
@returns(200)

@endgroup

@group getRecentChanges
@endpoint GET /getRecentChanges
@required {timestamp: any}
@returns(200)

@endgroup

@group login
@endpoint GET /login
@required {name: any, pass: any}
@returns(200)

@endgroup

@group updatePathway
@endpoint GET /updatePathway
@required {pwId: any, description: any, gpml: any, revision: any, auth: any, username: any}
@returns(200)

@endgroup

@group createPathway
@endpoint POST /createPathway
@required {gpml: any, auth: any, username: any}
@returns(200)

@endgroup

@group findPathwaysByText
@endpoint GET /findPathwaysByText
@required {query: any}
@optional {species: any}
@returns(200)

@endgroup

@group findPathwaysByXref
@endpoint GET /findPathwaysByXref
@required {ids: any}
@optional {codes: any}
@returns(200)

@endgroup

@group removeCurationTag
@endpoint GET /removeCurationTag
@required {pwId: any, tagName: any, auth: any, username: any}
@returns(200)

@endgroup

@group saveCurationTag
@endpoint GET /saveCurationTag
@required {pwId: any, tagName: any, text: any, revision: any, auth: any, username: any}
@returns(200)

@endgroup

@group getCurationTags
@endpoint GET /getCurationTags
@required {pwId: any}
@returns(200)

@endgroup

@group getCurationTagsByName
@endpoint GET /getCurationTagsByName
@required {tagName: any}
@returns(200)

@endgroup

@group getCurationTagHistory
@endpoint GET /getCurationTagHistory
@required {pwId: any}
@optional {timestamp: any}
@returns(200)

@endgroup

@group getColoredPathway
@endpoint GET /getColoredPathway
@required {pwId: any, revision: any, graphId: any, color: any, fileType: any}
@returns(200)

@endgroup

@group findInteractions
@endpoint GET /findInteractions
@required {query: any}
@returns(200)

@endgroup

@group getXrefList
@endpoint GET /getXrefList
@required {pwId: any, code: any}
@returns(200)

@endgroup

@group findPathwaysByLiterature
@endpoint GET /findPathwaysByLiterature
@required {query: any}
@returns(200)

@endgroup

@group saveOntologyTag
@endpoint GET /saveOntologyTag
@required {pwId: any, term: any, termId: any, auth: any, user: any}
@returns(200)

@endgroup

@group removeOntologyTag
@endpoint GET /removeOntologyTag
@required {pwId: any, termId: any, auth: any, user: any}
@returns(200)

@endgroup

@group getOntologyTermsByPathway
@endpoint GET /getOntologyTermsByPathway
@required {pwId: any}
@returns(200)

@endgroup

@group getPathwaysByOntologyTerm
@endpoint GET /getPathwaysByOntologyTerm
@required {term: any}
@returns(200)

@endgroup

@group getPathwaysByParentOntologyTerm
@endpoint GET /getPathwaysByParentOntologyTerm
@required {term: any}
@returns(200)

@endgroup

@group getUserByOrcid
@endpoint GET /getUserByOrcid
@required {orcid: any}
@returns(200)

@endgroup

@end