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.

Sign up for GitHub

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

Fix api documentation errors #845

Merged
merged 13 commits into from
Feb 10, 2025
Merged

Fix api documentation errors #845

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
d00b849
Fix V2 Ontology Controller documentation
haideriqbal Feb 6, 2025
7d9a345
Fix V2 Property Controller documentation
haideriqbal Feb 6, 2025
30a3d8b
Fix V2 Entity Controller documentation
haideriqbal Feb 6, 2025
fecc0f3
Fix V2 Class Controller documentation
haideriqbal Feb 6, 2025
64db0ab
Update V1 Ontology Individual Controller documentation
haideriqbal Feb 10, 2025
fd85c2b
Update V1 Ontology Term Controller documentation
haideriqbal Feb 10, 2025
b934df4
Update V1 Term Controller documentation
haideriqbal Feb 10, 2025
39ff475
Update V1 Property Controller documentation
haideriqbal Feb 10, 2025
80b4309
Update V1 Individual Controller documentation
haideriqbal Feb 10, 2025
5fc27e3
Update V1 Individual Controller documentation
haideriqbal Feb 10, 2025
546e3a7
Update V1 Property Controller documentation
haideriqbal Feb 10, 2025
c5ad13a
Update V1 Ontology Property Controller documentation
haideriqbal Feb 10, 2025
185a083
Update V2 Individual Controller documentation
haideriqbal Feb 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions backend/src/main/java/uk/ac/ebi/spot/ols/controller/api/v1/V1IndividualController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ HttpEntity<PagedModel<V1Individual>> getAllIndividuals(
@PathVariable("iri")
@Parameter(name = "iri",
description = "The IRI of the individual, this value must be double URL encoded",
example = "http%3A%252F%2Fpurl.obolibrary.org%2Fobo%2FIAO_0000124") String termId,
example = "http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FGAZ_00043159") String termId,
@RequestParam(value = "lang", required = false, defaultValue = "en") String lang,
@Parameter(hidden = true) Pageable pageable,
@Parameter(hidden = true) PagedResourcesAssembler assembler) {
Expand All @@ -69,16 +69,16 @@ HttpEntity<PagedModel<V1Individual>> getAllIndividuals(
HttpEntity<PagedModel<V1Individual>> getAllIndividuals(
@RequestParam(value = "iri", required = false)
@Parameter(name = "iri",
description = "The IRI of the individual, this value must be double URL encoded",
example = "http%3A%252F%2Fpurl.obolibrary.org%2Fobo%2FIAO_0000124") String iri,
description = "The IRI of the individual.",
example = "http://purl.obolibrary.org/obo/GAZ_00043159") String iri,
@RequestParam(value = "short_form", required = false)
@Parameter(name = "short_form",
description = "This refers to the short form of the individual.",
example = "IAO_0000124") String shortForm,
example = "GAZ_00043159") String shortForm,
@RequestParam(value = "obo_id", required = false)
@Parameter(name = "obo_id",
description = "This refers to the OBO ID of the individual.",
example = "IAO:0000124") String oboId,
example = "GAZ:00043159") String oboId,
@RequestParam(value = "lang", required = false, defaultValue = "en") String lang,
@Parameter(hidden = true) Pageable pageable,
@Parameter(hidden = true) PagedResourcesAssembler assembler) {
Expand All @@ -103,7 +103,7 @@ HttpEntity<PagedModel<V1Individual>> getAllIndividualsByIdAndIsDefiningOntology(
@PathVariable("iri")
@Parameter(name = "iri",
description = "The IRI of the individual, this value must be double URL encoded",
example = "http%3A%252F%2Fpurl.obolibrary.org%2Fobo%2FIAO_0000124") String termId,
example = "http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FOHD_0000363") String termId,
@RequestParam(value = "lang", required = false, defaultValue = "en") String lang,
@Parameter(hidden = true) Pageable pageable,
@Parameter(hidden = true) PagedResourcesAssembler assembler) {
Expand All @@ -121,15 +121,15 @@ HttpEntity<PagedModel<V1Individual>> getAllIndividualsByIdAndIsDefiningOntology(
@RequestParam(value = "iri", required = false)
@Parameter(name = "iri",
description = "The IRI of the individual, this value must be double URL encoded",
example = "http%3A%252F%2Fpurl.obolibrary.org%2Fobo%2FIAO_0000124") String iri,
example = "http://purl.obolibrary.org/obo/OHD_0000363") String iri,
@RequestParam(value = "short_form", required = false)
@Parameter(name = "short_form",
description = "This refers to the short form of the individual.",
example = "IAO_0000124") String shortForm,
example = "OHD_0000363") String shortForm,
@RequestParam(value = "obo_id", required = false)
@Parameter(name = "obo_id",
description = "This refers to the OBO ID of the individual.",
example = "IAO:0000124") String oboId,
example = "OHD:0000363") String oboId,
@RequestParam(value = "lang", required = false, defaultValue = "en") String lang,
@Parameter(hidden = true) Pageable pageable,
@Parameter(hidden = true) PagedResourcesAssembler assembler) {
Expand Down
8 changes: 4 additions & 4 deletions ...nd/src/main/java/uk/ac/ebi/spot/ols/controller/api/v1/V1OntologyIndividualController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,16 +65,16 @@ HttpEntity<PagedModel<V1Individual>> getAllIndividualsByOntology(
example = "iao") String ontologyId,
@RequestParam(value = "iri", required = false)
@Parameter(name = "iri",
description = "The IRI of the individual, this IRI should exist in the specified ontology by {onto} param. This value must be double URL encoded",
example = "http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FIAO_0000103") String iri,
description = "The IRI of the individual, this IRI should exist in the specified ontology by {onto} param.",
example = "http://purl.obolibrary.org/obo/IAO_0000002") String iri,
@RequestParam(value = "short_form", required = false)
@Parameter(name = "short_form",
description = "This refers to the short form of the individual, it should exist in the specified ontology by {onto} param.",
example = "IAO_0000124") String shortForm,
example = "IAO_0000002") String shortForm,
@RequestParam(value = "obo_id", required = false)
@Parameter(name = "obo_id",
description = "This refers to the OBO ID of the individual, it should exist in the specified ontology by {onto} param.",
example = "IAO:0000124") String oboId,
example = "IAO:0000002") String oboId,
@RequestParam(value = "lang", required = false, defaultValue = "en") String lang,
@Parameter(hidden = true) Pageable pageable,
@Parameter(hidden = true) PagedResourcesAssembler assembler) {
Expand Down
24 changes: 12 additions & 12 deletions backend/src/main/java/uk/ac/ebi/spot/ols/controller/api/v1/V1OntologyPropertyController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ HttpEntity<PagedModel<V1Property>> getAllPropertiesByOntology(
example = "duo") String ontologyId,
@RequestParam(value = "iri", required = false)
@Parameter(name = "iri",
description = "The IRI of the property, this IRI should exist in the specified ontology by {onto} param. This value must be double URL encoded",
example = "http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FDUO_0000041") String iri,
description = "The IRI of the property, this IRI should exist in the specified ontology by {onto} param.",
example = "http://purl.obolibrary.org/obo/DUO_0000041") String iri,
@RequestParam(value = "short_form", required = false)
@Parameter(name = "short_form",
description = "This refers to the short form of the property, it should exist in the specified ontology by {onto} param.",
Expand Down Expand Up @@ -146,7 +146,7 @@ HttpEntity<PagedModel<V1Property>> getParents(
@PathVariable("iri")
@Parameter(name = "iri",
description = "The IRI of the property, this IRI should exist in the specified ontology by {onto} param. This value must be double URL encoded",
example = "http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FDUO_0000041") String termId,
example = "http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FBFO_0000179") String termId,
@RequestParam(value = "lang", required = false, defaultValue = "en") String lang,
@Parameter(hidden = true) Pageable pageable,
@Parameter(hidden = true) PagedResourcesAssembler assembler) {
Expand All @@ -161,12 +161,12 @@ HttpEntity<PagedModel<V1Property>> getParents(
HttpEntity<PagedModel<V1Property>> children(
@PathVariable("onto")
@Parameter(name = "onto",
description = "The ID of the ontology. For example for Data Use Ontology, the ID is duo.",
example = "duo") String ontologyId,
description = "The ID of the ontology.",
example = "mondo") String ontologyId,
@PathVariable("iri")
@Parameter(name = "iri",
description = "The IRI of the property, this IRI should exist in the specified ontology by {onto} param. This value must be double URL encoded",
example = "http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FDUO_0000041") String termId,
example = "http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FBFO_0000051") String termId,
@RequestParam(value = "lang", required = false, defaultValue = "en") String lang,
@Parameter(hidden = true) Pageable pageable,
@Parameter(hidden = true) PagedResourcesAssembler assembler) {
Expand All @@ -181,12 +181,12 @@ HttpEntity<PagedModel<V1Property>> children(
HttpEntity<PagedModel<V1Property>> descendants(
@PathVariable("onto")
@Parameter(name = "onto",
description = "The ID of the ontology. For example for Data Use Ontology, the ID is duo.",
example = "duo") String ontologyId,
description = "The ID of the ontology.",
example = "mondo") String ontologyId,
@PathVariable("iri")
@Parameter(name = "iri",
description = "The IRI of the property, this IRI should exist in the specified ontology by {onto} param. This value must be double URL encoded",
example = "http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FDUO_0000041") String termId,
example = "http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FBFO_0000051") String termId,
@RequestParam(value = "lang", required = false, defaultValue = "en") String lang,
@Parameter(hidden = true) Pageable pageable,
@Parameter(hidden = true) PagedResourcesAssembler assembler) {
Expand All @@ -201,12 +201,12 @@ HttpEntity<PagedModel<V1Property>> descendants(
HttpEntity<PagedModel<V1Property>> ancestors(
@PathVariable("onto")
@Parameter(name = "onto",
description = "The ID of the ontology. For example for Data Use Ontology, the ID is duo.",
example = "duo") String ontologyId,
description = "The ID of the ontology.",
example = "mondo") String ontologyId,
@PathVariable("iri")
@Parameter(name = "iri",
description = "The IRI of the property, this IRI should exist in the specified ontology by {onto} param. This value must be double URL encoded",
example = "http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FDUO_0000041") String termId,
example = "http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FBFO_0000051") String termId,
@RequestParam(value = "lang", required = false, defaultValue = "en") String lang,
@Parameter(hidden = true) Pageable pageable,
@Parameter(hidden = true) PagedResourcesAssembler assembler) {
Expand Down
34 changes: 17 additions & 17 deletions backend/src/main/java/uk/ac/ebi/spot/ols/controller/api/v1/V1OntologyTermController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,8 @@ private HttpEntity<PagedModel<V1Term>> termsByOntology(
example = "duo") String ontologyId,
@RequestParam(value = "iri", required = false)
@Parameter(name = "iri",
description = "The IRI of the term, this value must be double URL encoded",
example = "http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FDUO_0000017") String iri,
description = "The IRI of the term.",
example = "http://purl.obolibrary.org/obo/DUO_0000017") String iri,
@RequestParam(value = "short_form", required = false)
@Parameter(name = "short_form",
description = "This refers to the short form of the term.",
Expand Down Expand Up @@ -444,7 +444,7 @@ HttpEntity<String> graphJsTreeChildren(
@PathVariable("iri")
@Parameter(name = "iri",
description = "The IRI of the property, this IRI should exist in the specified ontology by {onto} param. This value must be double URL encoded",
example = "http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FBFO_0000051") String termId,
example = "http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FDUO_0000017") String termId,
@PathVariable("nodeid")
@Parameter(name = "nodeid",
description = "This is the id of the node in the jstree of ontology specified by {onto} parameter",
Expand Down Expand Up @@ -524,8 +524,8 @@ HttpEntity<PagedModel<V1Term>> termChildrenByOntology(
example = "duo") String ontologyId,
@RequestParam(value = "iri", required = false)
@Parameter(name = "iri",
description = "The IRI of the term, this value must be double URL encoded",
example = "http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FDUO_0000017") String iri,
description = "The IRI of the term.",
example = "http://purl.obolibrary.org/obo/DUO_0000017") String iri,
@RequestParam(value = "short_form", required = false)
@Parameter(name = "short_form",
description = "This refers to the short form of the term.",
Expand Down Expand Up @@ -562,8 +562,8 @@ HttpEntity<PagedModel<V1Term>> termDescendantsByOntology(
example = "duo") String ontologyId,
@RequestParam(value = "iri", required = false)
@Parameter(name = "iri",
description = "The IRI of the term, this value must be double URL encoded",
example = "http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FDUO_0000017") String iri,
description = "The IRI of the term.",
example = "http://purl.obolibrary.org/obo/DUO_0000017") String iri,
@RequestParam(value = "short_form", required = false)
@Parameter(name = "short_form",
description = "This refers to the short form of the term.",
Expand Down Expand Up @@ -600,8 +600,8 @@ HttpEntity<PagedModel<V1Term>> termHierarchicalChildrenByOntology(
example = "duo") String ontologyId,
@RequestParam(value = "iri", required = false)
@Parameter(name = "iri",
description = "The IRI of the term, this value must be double URL encoded",
example = "http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FDUO_0000017") String iri,
description = "The IRI of the term.",
example = "http://purl.obolibrary.org/obo/DUO_0000017") String iri,
@RequestParam(value = "short_form", required = false)
@Parameter(name = "short_form",
description = "This refers to the short form of the term.",
Expand Down Expand Up @@ -638,8 +638,8 @@ HttpEntity<PagedModel<V1Term>> termHierarchicalDescendantsByOntology(
example = "duo") String ontologyId,
@RequestParam(value = "iri", required = false)
@Parameter(name = "iri",
description = "The IRI of the term, this value must be double URL encoded",
example = "http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FDUO_0000017") String iri,
description = "The IRI of the term.",
example = "http://purl.obolibrary.org/obo/DUO_0000017") String iri,
@RequestParam(value = "short_form", required = false)
@Parameter(name = "short_form",
description = "This refers to the short form of the term.",
Expand Down Expand Up @@ -676,8 +676,8 @@ HttpEntity<PagedModel<V1Term>> termParentsByOntology(
example = "duo") String ontologyId,
@RequestParam(value = "iri", required = false)
@Parameter(name = "iri",
description = "The IRI of the term, this value must be double URL encoded",
example = "http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FDUO_0000017") String iri,
description = "The IRI of the term.",
example = "http://purl.obolibrary.org/obo/DUO_0000017") String iri,
@RequestParam(value = "short_form", required = false)
@Parameter(name = "short_form",
description = "This refers to the short form of the term.",
Expand Down Expand Up @@ -714,8 +714,8 @@ HttpEntity<PagedModel<V1Term>> termAncestorsByOntology(
example = "duo") String ontologyId,
@RequestParam(value = "iri", required = false)
@Parameter(name = "iri",
description = "The IRI of the term, this value must be double URL encoded",
example = "http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FDUO_0000017") String iri,
description = "The IRI of the term.",
example = "http://purl.obolibrary.org/obo/DUO_0000017") String iri,
@RequestParam(value = "short_form", required = false)
@Parameter(name = "short_form",
description = "This refers to the short form of the term.",
Expand Down Expand Up @@ -752,8 +752,8 @@ HttpEntity<PagedModel<V1Term>> termHierarchicalAncestorsByOntology(
example = "duo") String ontologyId,
@RequestParam(value = "iri", required = false)
@Parameter(name = "iri",
description = "The IRI of the term, this value must be double URL encoded",
example = "http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FDUO_0000017") String iri,
description = "The IRI of the term.",
example = "http://purl.obolibrary.org/obo/DUO_0000017") String iri,
@RequestParam(value = "short_form", required = false)
@Parameter(name = "short_form",
description = "This refers to the short form of the term.",
Expand Down
12 changes: 6 additions & 6 deletions backend/src/main/java/uk/ac/ebi/spot/ols/controller/api/v1/V1PropertyController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ HttpEntity<PagedModel<V1Property>> getPropertiesByIri(@PathVariable("iri")
HttpEntity<PagedModel<V1Property>> getAllProperties(
@RequestParam(value = "iri", required = false)
@Parameter(name = "iri",
description = "The IRI of the property, this value must be double URL encoded",
example = "http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FDUO_0000041") String iri,
description = "The IRI of the property",
example = "http://purl.obolibrary.org/obo/DUO_0000041") String iri,
@RequestParam(value = "short_form", required = false)
@Parameter(name = "short_form",
description = "This refers to the short form of the property.",
Expand Down Expand Up @@ -118,16 +118,16 @@ HttpEntity<PagedModel<V1Property>> getPropertiesByIriAndIsDefiningOntology(@Path
HttpEntity<PagedModel<V1Property>> getPropertiesByIdAndIsDefiningOntology(
@RequestParam(value = "iri", required = false)
@Parameter(name = "iri",
description = "The IRI of the property, this value must be double URL encoded",
example = "http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FDUO_0000041") String iri,
description = "The IRI of the property.",
example = "http://purl.obolibrary.org/obo/GALLONT_0000000") String iri,
@RequestParam(value = "short_form", required = false)
@Parameter(name = "short_form",
description = "This refers to the short form of the property.",
example = "DUO_0000041") String shortForm,
example = "GALLONT_0000000") String shortForm,
@RequestParam(value = "obo_id", required = false)
@Parameter(name = "obo_id",
description = "This refers to the OBO ID of the property.",
example = "DUO:0000041") String oboId,
example = "GALLONT:0000000") String oboId,
@RequestParam(value = "lang", required = false, defaultValue = "en") String lang,
@Parameter(hidden = true) Pageable pageable,
@Parameter(hidden = true) PagedResourcesAssembler assembler) {
Expand Down
Loading
Loading