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.

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

Remove static yamls parsing and use UBKG calls #566

Merged
merged 16 commits into from
Nov 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.1.38
2.1.39
98 changes: 44 additions & 54 deletions entity-api-spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -406,59 +406,6 @@ components:
- section
- suspension
description: "A code representing the type of specimen. Must be an organ, block, section, or suspension"
specimen_type:
type: string
enum:
- atacseq
- biopsy
- blood
- cell_lysate
- clarity_hydrogel
- codex
- cryosections_curls_from_fresh_frozen_oct
- cryosections_curls_rnalater
- ffpe_block
- ffpe_slide
- fixed_frozen_section_slide
- fixed_tissue_piece
- flash_frozen_liquid_nitrogen
- formalin_fixed_oct_block
- fresh_frozen_oct_block
- fresh_frozen_section_slide
- fresh_frozen_tissue
- fresh_frozen_tissue_section
- fresh_tissue
- frozen_cell_pellet_buffy_coat
- gdna
- module
- nuclei
- nuclei_rnalater
- organ
- organ_piece
- other
- pbmc
- pfa_fixed_frozen_oct_block
- plasma
- protein
- ran_poly_a_enriched
- rna_total
- rnalater_treated_and_stored
- rnaseq
- scatacseq
- scrnaseq
- segment
- seqfish
- sequence_library
- serum
- single_cell_cryopreserved
- snatacseq
- snrnaseq
- tissue_lysate
- wgs
description: "DEPRECATED: No longer a required field. A code representing the type of specimen. Must be one of the codes specified in: [tissue sample types](https://github.com/hubmapconsortium/search-api/blob/main/src/search-schema/data/definitions/enums/tissue_sample_types.yaml)"
specimen_type_other:
type: string
description: "The user provided sample type if the 'other' sample_type is chosen."
protocol_url:
type: string
description: "The protocols.io doi url pointing the protocol under wich the sample was obtained and/or prepared."
Expand Down Expand Up @@ -1874,6 +1821,49 @@ paths:
description: The target dataset could not be found
'500':
description: Internal error
'/datasets/{id}/multi-revisions':
get:
summary: 'Retrieve a list of all multi revisions of a dataset from the id of any dataset in the chain. E.g: If there are 5 revisions, and the id for revision 4 is given, a list of revisions 1-5 will be returned in reverse order (newest first). Non-public access is only required to retrieve information on non-published datasets. Output will be a list of dictionaries. Each dictionary contains the dataset revision number and its list of uuids. Optionally, the full dataset can be included for each.'
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: include_dataset
in: query
description: A case insensitive string. Any value besides true will have no effect. If the string is 'true', the full dataset for each revision will be included in the response
required: false
schema:
type: string
enum: ['true', 'false']
responses:
'200':
description: The list of revised datasets that the referenced dataset is a member of including the index number of the revision, where 1 is the oldest version of any revision chain
content:
application/json:
schema:
type: object
properties:
uuid:
type: string
description: The uuid of a dataset
revision_number:
type: integer
description: The number in the revision chain of this dataset where 1 is the oldest revision
dataset:
$ref: '#/components/schemas/Dataset'
'400':
description: Invalid or misformatted entity identifier, or the given entity is not a Dataset
'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 query the revision number of the given dataset.
'404':
description: The target dataset could not be found
'500':
description: Internal error
'/datasets/{id}/revisions':
get:
summary: 'From a given ID of a versioned dataset, retrieve a list of every dataset in the chain ordered from most recent to oldest. The revision number, as well as the dataset uuid will be included. An optional parameter ?include_dataset=true will include the full dataset for each revision as well. Public/Consortium access rules apply, if is for a non-public dataset and no token or a token without membership in HuBMAP-Read group is sent with the request then a 403 response should be returned. If the given id is published, but later revisions are not and the user is not in HuBMAP-Read group, only published revisions will be returned. The field next_revision_uuid will not be returned if the next revision is unpublished'
Expand All @@ -1890,7 +1880,7 @@ paths:
required: false
schema:
type: string
enum: ['true', 'false']
enum: [ 'true', 'false' ]
responses:
'200':
description: The list of revised datasets that the referenced dataset is a member of including the index number of the revision, where 1 is the oldest version of any revision chain
Expand Down
Loading