Skip to content

Commit

Permalink
added entity spec entry for tuplets. Also changed some comments to use
Browse files Browse the repository at this point in the history
the term parent rather than ancestor for specificity
  • Loading branch information
DerekFurstPitt committed Jan 30, 2024
1 parent ec3bfa5 commit cab1a5e
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 1 deletion.
45 changes: 45 additions & 0 deletions entity-api-spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1544,6 +1544,51 @@ paths:
description: The target entity could not be found
'500':
description: Internal error
'/tuplets/{id}':
get:
summary: Get the tuplets list for an Entity. The tuplets have the same parent activity node.
parameters:
- name: id
in: path
description: The unique identifier of entity. This identifier can be either an HuBMAP ID (e.g. HBM123.ABCD.456) or UUID
required: true
schema:
type: string
- name: status
in: query
description: A case insensitive string. Any value besides 'new', 'qa', and 'published' will raise an error. If a valid status is provided, only results matching that status (if they are datasets) will be returned
equired: false
schema:
type: string
enum: [ 'new', 'qa', 'published' ]
- name: property_key
in: query
description: A case insensitive string. Any value besides 'uuid' will raise an error. If property_key=uuid is provided, rather than entire dictionary representations of each node, only the list of matching uuid's will be returned
required: false
schema:
type: string
enum: [ 'uuid' ]
responses:
'200':
description: An array of tuplet entities is returned
content:
application/json:
schema:
type: array
items:
anyOf:
- $ref: '#/components/schemas/Sample'
- $ref: '#/components/schemas/Dataset'
'400':
description: Invalid or misformatted entity identifier
'401':
description: The user's token has expired or the user did not supply a valid token
'403':
description: The user is not authorized to access the entity.
'404':
description: The target entity could not be found
'500':
description: Internal error
'/entities/{id}/provenance':
get:
summary: 'Get Provenance Data for Entity. This returns a PROV JSON compliant representation of the entity''s provenance. Refer to this document for more information regarding [PROV JSON format](https://www.w3.org/Submission/2013/SUBM-prov-json-20130424/)'
Expand Down
2 changes: 1 addition & 1 deletion src/app.py
Original file line number Diff line number Diff line change
Expand Up @@ -1826,7 +1826,7 @@ def get_siblings(id):


"""
Get all tuplets of the given entit: sibling entities sharing an ancestor activity
Get all tuplets of the given entit: sibling entities sharing an parent activity
The gateway treats this endpoint as public accessible
Expand Down

0 comments on commit cab1a5e

Please sign in to comment.