Skip to content

Commit 371831b

Browse files
authored
Merge pull request #384 from genestack/feature/Xrefsets-API-description-update
Description updated to notify the existing limitation
2 parents 25894c7 + d05b13d commit 371831b

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

openapi/v1/odmApi.yaml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18026,6 +18026,9 @@ paths:
1802618026
post:
1802718027
operationId: "create"
1802818028
requestBody:
18029+
description: "Request body for creating a new xrefset.\n## Important:\nThe\
18030+
\ length of 'sourceId' strings is limited to 255 characters. Ensure that\
18031+
\ the provided values adhere to this limitation to avoid data truncation.\n"
1802918032
content:
1803018033
application/json:
1803118034
schema:
@@ -18073,7 +18076,9 @@ paths:
1807318076
targetId\" and \"sourceId\". If non-empty lists of values for \"targetId\"\
1807418077
\ and \"sourceId\" are supplied, the following search rule is applied: (sourceId\
1807518078
\ = \"S1\" OR .. sourceId = \"Sn\") AND (targetId = \"T1\" OR .. targetId\
18076-
\ = \"Tm\").\n\n"
18079+
\ = \"Tm\").\n## Important:\nThe length of 'sourceId' strings is limited to\
18080+
\ 255 characters. Ensure that the provided values adhere to this limitation\
18081+
\ to avoid data truncation.\n"
1807718082
operationId: "searchEntries"
1807818083
parameters:
1807918084
- description: "Supply sourceId in the format \"sourceId\". For transcript-gene\

openapi/v1/referenceData.yaml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ paths:
1111
post:
1212
operationId: create
1313
requestBody:
14+
description: |+
15+
Request body for creating a new xrefset.
16+
## Important:
17+
The length of 'sourceId' strings is limited to 255 characters. Ensure that the provided values adhere to this limitation to avoid data truncation.
1418
content:
1519
application/json:
1620
schema:
@@ -56,7 +60,8 @@ paths:
5660
description: |+
5761
## Conditions
5862
It is possible to supply a list of values for "targetId" and "sourceId". If non-empty lists of values for "targetId" and "sourceId" are supplied, the following search rule is applied: (sourceId = "S1" OR .. sourceId = "Sn") AND (targetId = "T1" OR .. targetId = "Tm").
59-
63+
## Important:
64+
The length of 'sourceId' strings is limited to 255 characters. Ensure that the provided values adhere to this limitation to avoid data truncation.
6065
operationId: searchEntries
6166
parameters:
6267
- description: "Supply sourceId in the format \"sourceId\". For transcript-gene\

0 commit comments

Comments
 (0)