Skip to content

Commit 9dc35ff

Browse files
nzorkic-genestackegor-alexandrov
nzorkic-genestack
and
egor-alexandrov
authored
ODM-12213: [HDF5] Display Contents in the API (#335)
* ODM-12213: add includeContents flag file endpoints --------- Co-authored-by: Egor Alexandrov <egor.alexandrov@genestack.com>
1 parent 0f21349 commit 9dc35ff

File tree

7 files changed

+99
-1
lines changed

7 files changed

+99
-1
lines changed

‎Earthfile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ python-api-client:
7373
pypi-clean.sh
7474

7575
r-api-client:
76-
FROM r-base:4.4.3
76+
FROM r-base:4.4.2
7777
WORKDIR /app
7878

7979
CACHE /root/.cache

‎gradle/wrapper/gradle-wrapper.properties‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
#
2+
# Copyright (c) 2011-2025 Genestack Limited
3+
# All Rights Reserved
4+
# THIS IS UNPUBLISHED PROPRIETARY SOURCE CODE OF GENESTACK LIMITED
5+
# The copyright notice above does not evidence any
6+
# actual or intended publication of such source code.
7+
#
8+
19
distributionBase=GRADLE_USER_HOME
210
distributionPath=wrapper/dists
311
distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-bin.zip

‎openapi/v1/fileCurator.yaml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,13 @@ paths:
118118
required: true
119119
schema:
120120
type: string
121+
- description: Select `true` in order to include file structure (contents) for .h5, .h5ad, .zip, .gz to the response.
122+
in: query
123+
name: includeContents
124+
required: false
125+
schema:
126+
default: false
127+
type: boolean
121128
responses:
122129
"200":
123130
content:
@@ -171,6 +178,13 @@ paths:
171178
description: Search for files via a full-text query over all file metadata.
172179
schema:
173180
type: string
181+
- in: query
182+
name: includeContents
183+
description: Select `true` in order to include file structure (contents) for .h5, .h5ad, .zip, .gz to the response.
184+
required: false
185+
schema:
186+
default: false
187+
type: boolean
174188
- in: query
175189
name: pageLimit
176190
description: Maximum number of results to return per page (see Paging above). This value must be

‎openapi/v1/fileUser.yaml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,13 @@ paths:
119119
required: true
120120
schema:
121121
type: string
122+
- description: Select `true` in order to include file structure (contents) for .h5, .h5ad, .zip, .gz to the response.
123+
in: query
124+
name: includeContents
125+
required: false
126+
schema:
127+
default: false
128+
type: boolean
122129
responses:
123130
"200":
124131
content:
@@ -172,6 +179,13 @@ paths:
172179
description: Search for files via a full-text query over all file metadata.
173180
schema:
174181
type: string
182+
- in: query
183+
name: includeContents
184+
description: Select `true` in order to include file structure (contents) for .h5, .h5ad, .zip, .gz to the response.
185+
required: false
186+
schema:
187+
default: false
188+
type: boolean
175189
- in: query
176190
name: pageLimit
177191
description: Maximum number of results to return per page (see Paging above). This value must be

‎openapi/v1/integrationCurator.yaml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6656,6 +6656,13 @@ paths:
66566656
required: true
66576657
schema:
66586658
type: string
6659+
- description: Select `true` in order to include file structure (contents) for .h5, .h5ad, .zip, .gz to the response.
6660+
in: query
6661+
name: includeContents
6662+
required: false
6663+
schema:
6664+
default: false
6665+
type: boolean
66596666
responses:
66606667
"200":
66616668
content:

‎openapi/v1/integrationUser.yaml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5074,6 +5074,13 @@ paths:
50745074
required: true
50755075
schema:
50765076
type: string
5077+
- description: Select `true` in order to include file structure (contents) for .h5, .h5ad, .zip, .gz to the response.
5078+
in: query
5079+
name: includeContents
5080+
required: false
5081+
schema:
5082+
default: false
5083+
type: boolean
50775084
responses:
50785085
"200":
50795086
content:

‎openapi/v1/odmApi.yaml‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1551,6 +1551,14 @@ paths:
15511551
required: true
15521552
schema:
15531553
type: "string"
1554+
- description: "Select `true` in order to include file structure (contents)\
1555+
\ for .h5, .h5ad, .zip, .gz to the response."
1556+
in: "query"
1557+
name: "includeContents"
1558+
required: false
1559+
schema:
1560+
default: false
1561+
type: "boolean"
15541562
responses:
15551563
"200":
15561564
content:
@@ -1610,6 +1618,14 @@ paths:
16101618
description: "Search for files via a full-text query over all file metadata."
16111619
schema:
16121620
type: "string"
1621+
- in: "query"
1622+
name: "includeContents"
1623+
description: "Select `true` in order to include file structure (contents)\
1624+
\ for .h5, .h5ad, .zip, .gz to the response."
1625+
required: false
1626+
schema:
1627+
default: false
1628+
type: "boolean"
16131629
- in: "query"
16141630
name: "pageLimit"
16151631
description: "Maximum number of results to return per page (see Paging above).\
@@ -1767,6 +1783,14 @@ paths:
17671783
required: true
17681784
schema:
17691785
type: "string"
1786+
- description: "Select `true` in order to include file structure (contents)\
1787+
\ for .h5, .h5ad, .zip, .gz to the response."
1788+
in: "query"
1789+
name: "includeContents"
1790+
required: false
1791+
schema:
1792+
default: false
1793+
type: "boolean"
17701794
responses:
17711795
"200":
17721796
content:
@@ -1826,6 +1850,14 @@ paths:
18261850
description: "Search for files via a full-text query over all file metadata."
18271851
schema:
18281852
type: "string"
1853+
- in: "query"
1854+
name: "includeContents"
1855+
description: "Select `true` in order to include file structure (contents)\
1856+
\ for .h5, .h5ad, .zip, .gz to the response."
1857+
required: false
1858+
schema:
1859+
default: false
1860+
type: "boolean"
18291861
- in: "query"
18301862
name: "pageLimit"
18311863
description: "Maximum number of results to return per page (see Paging above).\
@@ -10300,6 +10332,14 @@ paths:
1030010332
required: true
1030110333
schema:
1030210334
type: "string"
10335+
- description: "Select `true` in order to include file structure (contents)\
10336+
\ for .h5, .h5ad, .zip, .gz to the response."
10337+
in: "query"
10338+
name: "includeContents"
10339+
required: false
10340+
schema:
10341+
default: false
10342+
type: "boolean"
1030310343
responses:
1030410344
"200":
1030510345
content:
@@ -15759,6 +15799,14 @@ paths:
1575915799
required: true
1576015800
schema:
1576115801
type: "string"
15802+
- description: "Select `true` in order to include file structure (contents)\
15803+
\ for .h5, .h5ad, .zip, .gz to the response."
15804+
in: "query"
15805+
name: "includeContents"
15806+
required: false
15807+
schema:
15808+
default: false
15809+
type: "boolean"
1576215810
responses:
1576315811
"200":
1576415812
content:

0 commit comments

Comments
 (0)