Skip to content

Commit

Permalink
Merge pull request #137 from x-atlas-consortia/jas_yaml_corrections
Browse files Browse the repository at this point in the history
Revisions to YAML spec files to clarify nodeobjects endpoint
  • Loading branch information
yuanzhou authored Jul 10, 2024
2 parents 0bdcf69 + 16cf6da commit 61523e3
Showing 2 changed files with 6 additions and 3 deletions.
4 changes: 2 additions & 2 deletions dd-api-spec.yaml
Original file line number Diff line number Diff line change
@@ -8,7 +8,7 @@ info:
url: https://github.com/TaylorResearchLab/CFDE_DataDistillery
externalDocs:
description: UBKG documentation
url: https://ubkg.docs.xconsortia.org/
url: https://ubkg.docs.xconsortia.org/api
servers:
- url: https://datadistillery.api.sennetconsortium.org/
description: Production server
@@ -169,7 +169,7 @@ paths:
/concepts/{concept_id}/nodeobjects:
get:
operationId: concepts_identifier_nodes_get
summary: Returns a set of "Concept Node objects" that "match" an identifier. [A Concept node in the UBKG is the origin of a subgraph that links the Concept node to a set of Code, Term, Definition, and Semantic Type nodes. A "Concept Node object" represents this subgraph as a set of Concept properties--i.e., all of the Concept's linked Codes, terms, definitions, and semantic types. A "match" is an exact match between an identifier and a text-based property in a Concept Node object. Because an identifier may match properties in more than one Concept Node object, the endpoint can return multiple Concept Node objects.]
summary: Returns a set of "Concept Node objects" (also known as concept subgraphs) that "match" an identifier. [A Concept node in the UBKG is the origin of a "concept subgraph" that links the Concept node to a set of Code, Term, Definition, and Semantic Type nodes. A "Concept Node object" represents this subgraph as a set of Concept properties--i.e., all of the Concept's linked Codes, terms, definitions, and semantic types. A "match" is an exact match between an identifier and a text-based property in a Concept Node object. Because an identifier may match properties in more than one Concept Node object, the endpoint can return multiple Concept Node objects.]
parameters:
- name: concept_id
in: path
5 changes: 4 additions & 1 deletion ubkg-api-spec.yaml
Original file line number Diff line number Diff line change
@@ -6,6 +6,9 @@ info:
contact:
name: GitHub repository
url: https://github.com/x-atlas-consortia/ubkg-api
externalDocs:
description: UBKG documentation
url: https://ubkg.docs.xconsortia.org/api
servers:
- url: https://ontology.api.hubmapconsortium.org
description: Production server
@@ -164,7 +167,7 @@ paths:
/concepts/{concept_id}/nodeobjects:
get:
operationId: concepts_identifier_nodes_get
summary: Returns a set of "Concept Node objects" that "match" an identifier. [A Concept node in the UBKG is the origin of a subgraph that links the Concept node to a set of Code, Term, Definition, and Semantic Type nodes. A "Concept Node object" represents this subgraph as a set of Concept properties--i.e., all of the Concept's linked Codes, terms, definitions, and semantic types. A "match" is an exact match between an identifier and a text-based property in a Concept Node object. Because an identifier may match properties in more than one Concept Node object, the endpoint can return multiple Concept Node objects.]
summary: Returns a set of "Concept Node objects" (also known as concept subgraphs) that "match" an identifier. [Each Concept node in the UBKG is the origin of a "concept subgraph" that links the Concept node to a set of Code, Term, Definition, and Semantic Type nodes. A "Concept Node object" represents this subgraph as a set of Concept properties--i.e., all of the Concept's linked Codes, terms, definitions, and semantic types. A "match" is an exact match between an identifier and a text-based property in a Concept Node object. Because an identifier may match properties in more than one Concept Node object, the endpoint can return multiple Concept Node objects.]
parameters:
- name: concept_id
in: path

0 comments on commit 61523e3

Please sign in to comment.