Skip to content

Commit

Permalink
Edited web endpoint/controllers descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
@IgorRodchenkov
IgorRodchenkov committed May 25, 2024
1 parent e455d43 commit 340054d
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
16 changes: 8 additions & 8 deletions src/main/java/cpath/web/ApiControllerV1.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public class ApiControllerV1 extends BasicController {
@GetMapping(path = "get",
produces = {"application/vnd.biopax.rdf+xml", "application/ld+json", "application/json", "application/xml", "text/plain"})
@Operation(
summary = "Fetch a BioPAX sub-model by URIs/IDs and optionally convert to another output format (query parameters must be URL-encoded and not too many).",
summary = "Fetch a BioPAX sub-model by URIs/IDs and optionally convert to another output format (query parameters must be URL-encoded and not too many)",
description = "Retrieve BioPAX pathways, interactions, physical entities from the db by URIs; " +
"optionally, convert the result to other <a href='/#formats'>output formats</a>."
)
Expand Down Expand Up @@ -73,7 +73,7 @@ public void fetchQuery(@Valid Fetch args, BindingResult bindingResult,
@GetMapping(path = "top_pathways",
produces = {APPLICATION_JSON_VALUE, APPLICATION_XML_VALUE})
@Operation(
summary = "HTTP GET, search for top pathways.",
summary = "Search for top-level bio pathways",
description = "Find root/parent Pathway objects, i.e, ones that are neither 'controlled' " +
"nor a 'pathwayComponent' of another biological process; trivial pathways are excluded from the results;" +
" can filter by <a href='/datasources'>datasource</a> and organism."
Expand All @@ -88,7 +88,7 @@ public SearchResponse topPathwaysQueryGet(@Valid TopPathways args, BindingResult
consumes = {APPLICATION_FORM_URLENCODED_VALUE},
produces = {APPLICATION_JSON_VALUE, APPLICATION_XML_VALUE})
@Operation(
summary = "Search for top-level bio pathways.",
summary = "Search for top-level bio pathways",
description = "Find root/parent Pathway objects that are neither <code>controlled</code> " +
"nor a <code>pathwayComponent</code> of another biological process; trivial pathways are excluded from the results;" +
" can filter by <a href='/datasources'>datasource</a> and organism."
Expand Down Expand Up @@ -117,7 +117,7 @@ public SearchResponse topPathwaysQuery(@Valid TopPathways args, BindingResult bi

@GetMapping(path = "traverse", produces = {APPLICATION_JSON_VALUE, APPLICATION_XML_VALUE})
@Operation(
summary = "Access properties of BioPAX elements using graph path expressions",
summary = "Access properties of BioPAX elements using graph path expressions (xpath-like)",
description = "To collect specific BioPAX property values, use the following path accessor format: " +
"InitialClass/property[:filterClass]/[property][:filterClass]... A \"*\" sign after the property " +
"instructs the path accessor to transitively traverse that property. For example, the following " +
Expand All @@ -140,7 +140,7 @@ public TraverseResponse traverseQueryGet(@Valid Traverse args, BindingResult bin
consumes = {APPLICATION_FORM_URLENCODED_VALUE},
produces = {APPLICATION_JSON_VALUE, APPLICATION_XML_VALUE})
@Operation(
summary = "Access properties of BioPAX elements using graph path expressions (xpath-like).",
summary = "Access properties of BioPAX elements using graph path expressions (xpath-like)",
description = "To collect specific BioPAX property values, use the following path accessor format: " +
"InitialClass/property[:filterClass]/[property][:filterClass]... A \"*\" sign after the property " +
"instructs the path accessor to transitively traverse that property. For example, the following " +
Expand Down Expand Up @@ -177,7 +177,7 @@ public TraverseResponse traverseQuery(@Valid Traverse args, BindingResult bindin
@GetMapping(path = "graph",
produces = {"application/vnd.biopax.rdf+xml", "application/ld+json", "application/json", "application/xml", "text/plain"})
@Operation(
summary = "BioPAX Graph Query and optional converter to another output format (parameters must be URL-encoded and not too many).",
summary = "A BioPAX graph query and optional converter to another output formats (parameters must be URL-encoded and not too many)",
description = "Find connections of bio network elements, such as the shortest path between " +
"two proteins or the neighborhood for a particular protein state or all states. " +
"Optionally, convert the result to other <a href='/#formats'>output formats</a>." +
Expand All @@ -195,7 +195,7 @@ public void graphQueryGet(@Valid Graph args, BindingResult bindingResult,
consumes = {APPLICATION_FORM_URLENCODED_VALUE},
produces = {"application/vnd.biopax.rdf+xml", "application/ld+json", "application/json", "application/xml", "text/plain"})
@Operation(
summary = "A BioPAX graph query and optional converter to another output format.",
summary = "A BioPAX graph query and optional converter to another output formats",
description = "Find connections of bio network elements, such as the shortest path between " +
"two proteins or the neighborhood for a particular protein state or all states. " +
"Optionally, convert the result to other <a href='/#formats'>output formats</a>." +
Expand Down Expand Up @@ -249,7 +249,7 @@ public void graphQuery(@Valid Graph args, BindingResult bindingResult,

@GetMapping(path = "search", produces = {APPLICATION_JSON_VALUE, APPLICATION_XML_VALUE})
@Operation(
summary = "Full-text search in the BioPAX database with Lucene query syntax",
summary = "Full-text search in the BioPAX model using Lucene query syntax",
description = """
<p>
The index field names are: <var>uri, keyword, name, pathway, xrefid, datasource, organism</var>.
Expand Down
12 changes: 6 additions & 6 deletions src/main/java/cpath/web/ApiControllerV2.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public void fetchQuery(@Valid @RequestBody Fetch args, BindingResult bindingResu

@PostMapping(path = "top_pathways", produces = {APPLICATION_JSON_VALUE, APPLICATION_XML_VALUE})
@Operation(
summary = "Search for top-level bio pathways.",
summary = "Search for top-level bio pathways",
description = "Find root/parent Pathway objects that are neither <code>controlled</code> " +
"nor a <code>pathwayComponent</code> of another biological process; trivial pathways are excluded from the results;" +
" can filter by <a href='/datasources'>datasource</a> and organism."
Expand Down Expand Up @@ -92,7 +92,7 @@ public SearchResponse topPathwaysQuery(@Valid @RequestBody TopPathways args, Bin

@PostMapping(path = "traverse", produces = {APPLICATION_JSON_VALUE, APPLICATION_XML_VALUE})
@Operation(
summary = "Access properties of BioPAX elements using graph path expressions (xpath-like).",
summary = "Access properties of BioPAX elements using graph path expressions (xpath-like)",
description = "To collect specific BioPAX property values, use the following path accessor format: " +
"InitialClass/property[:filterClass]/[property][:filterClass]... A \"*\" sign after the property " +
"instructs the path accessor to transitively traverse that property. For example, the following " +
Expand Down Expand Up @@ -173,7 +173,7 @@ public SearchResponse searchQuery(@Valid @RequestBody Search args, BindingResult
@PostMapping(path = "neighborhood",
produces = {"application/vnd.biopax.rdf+xml", "application/ld+json", "application/json", "application/xml", "text/plain"})
@Operation(
summary = "BioPAX Neighborhood graph query and optional converter to another output format.",
summary = "BioPAX Neighborhood graph query and optional converter to another output format",
description = "Find the neighborhood network given the source bio entity URIs/IDs. " +
"Optionally, convert the result to other <a href='/#formats'>output formats</a>."
)
Expand All @@ -198,7 +198,7 @@ public void neighborhoodQuery(@Valid @RequestBody Neighborhood args, BindingResu
@PostMapping(path = "pathsbetween",
produces = {"application/vnd.biopax.rdf+xml", "application/ld+json", "application/json", "application/xml", "text/plain"})
@Operation(
summary = "BioPAX PathsBetween graph query and optional converter to another output format.",
summary = "BioPAX PathsBetween graph query and optional converter to another output format",
description = "Find the BioPAX subnetwork that includes all paths between given source bio entities (URIs/IDs). " +
"Optionally, convert the result to other <a href='/#formats'>output formats</a>."
)
Expand All @@ -223,7 +223,7 @@ public void pathsbetweenQuery(@Valid @RequestBody PathsBetween args, BindingResu
@PostMapping(path = "pathsfromto",
produces = {"application/vnd.biopax.rdf+xml", "application/ld+json", "application/json", "application/xml", "text/plain"})
@Operation(
summary = "BioPAX PathsFromTo graph query and optional converter to another output format.",
summary = "BioPAX PathsFromTo graph query and optional converter to another output format",
description = "Find a subnetwork that includes entities on the paths from the source bio " +
"entities (URIs/IDs) to the targets (if empty array, then PathsBetween algorithm is used). " +
"Optionally, convert the result to other <a href='/#formats'>output formats</a>."
Expand All @@ -249,7 +249,7 @@ public void pathsfromtoQuery(@Valid @RequestBody PathsFromTo args, BindingResult
@PostMapping(path = "commonstream",
produces = {"application/vnd.biopax.rdf+xml", "application/ld+json", "application/json", "application/xml", "text/plain"})
@Operation(
summary = "BioPAX CommonStream graph query and optional converter to another output format.",
summary = "BioPAX CommonStream graph query and optional converter to another output format",
description = "Find a BioPAX common stream subnetwork from the source bio entities (URIs/IDs). " +
"Optionally, convert the result to other <a href='/#formats'>output formats</a>."
)
Expand Down

0 comments on commit 340054d

Please sign in to comment.