Skip to content

Commit db58e26

Browse files
box-apimgmtbox-apimgmt
authored
docs: Update collaboration resource (#483)
1 parent 966decb commit db58e26

File tree

1 file changed

+149
-31
lines changed

1 file changed

+149
-31
lines changed

‎openapi.json‎

Lines changed: 149 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"url": "http://www.apache.org/licenses/LICENSE-2.0"
1515
},
1616
"version": "2.0.0",
17-
"x-box-commit-hash": "98d60db47f"
17+
"x-box-commit-hash": "8edc17f8ac"
1818
},
1919
"servers": [
2020
{
@@ -6252,6 +6252,28 @@
62526252
"name"
62536253
],
62546254
"explode": false
6255+
},
6256+
{
6257+
"name": "limit",
6258+
"in": "query",
6259+
"description": "The maximum number of items to return per page.",
6260+
"required": false,
6261+
"schema": {
6262+
"type": "integer",
6263+
"format": "int64",
6264+
"maximum": 1000
6265+
},
6266+
"example": 1000
6267+
},
6268+
{
6269+
"name": "marker",
6270+
"in": "query",
6271+
"description": "Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.",
6272+
"required": false,
6273+
"schema": {
6274+
"type": "string"
6275+
},
6276+
"example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
62556277
}
62566278
],
62576279
"responses": {
@@ -7839,6 +7861,28 @@
78397861
"format": "uuid"
78407862
},
78417863
"example": "01234500-12f1-1234-aa12-b1d234cb567e"
7864+
},
7865+
{
7866+
"name": "marker",
7867+
"in": "query",
7868+
"description": "Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.",
7869+
"required": false,
7870+
"schema": {
7871+
"type": "string"
7872+
},
7873+
"example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
7874+
},
7875+
{
7876+
"name": "limit",
7877+
"in": "query",
7878+
"description": "The maximum number of items to return per page.",
7879+
"required": false,
7880+
"schema": {
7881+
"type": "integer",
7882+
"format": "int64",
7883+
"maximum": 1000
7884+
},
7885+
"example": 1000
78427886
}
78437887
],
78447888
"responses": {
@@ -10089,7 +10133,7 @@
1008910133
"content": {
1009010134
"application/json": {
1009110135
"schema": {
10092-
"$ref": "#/components/schemas/Collaborations"
10136+
"$ref": "#/components/schemas/CollaborationsOffsetPaginated"
1009310137
}
1009410138
}
1009510139
}
@@ -16347,7 +16391,7 @@
1634716391
"content": {
1634816392
"application/json": {
1634916393
"schema": {
16350-
"$ref": "#/components/schemas/Collaborations"
16394+
"$ref": "#/components/schemas/CollaborationsOffsetPaginated"
1635116395
}
1635216396
}
1635316397
}
@@ -17785,7 +17829,7 @@
1778517829
"content": {
1778617830
"application/json": {
1778717831
"schema": {
17788-
"$ref": "#/components/schemas/Items"
17832+
"$ref": "#/components/schemas/ItemsOffsetPaginated"
1778917833
}
1779017834
}
1779117835
}
@@ -25963,12 +26007,12 @@
2596326007
"type": "object",
2596426008
"properties": {
2596526009
"enterprise_has_strong_password_required_for_external_users": {
25966-
"description": "Whether or not the enterprise that owns the content requires\na strong password to collaborate on the content.",
26010+
"description": "Whether or not the enterprise that owns the content requires\na strong password to collaborate on the content, or enforces\nan exposed password detection for the external collaborators.",
2596726011
"type": "boolean",
2596826012
"example": true
2596926013
},
2597026014
"user_has_strong_password": {
25971-
"description": "Whether or not the user has a strong password set for their\naccount. The field is `null` when a strong password is not\nrequired.",
26015+
"description": "Whether or not the user has a strong and not exposed password set\nfor their account. The field is `null` when a strong password is\nnot required.",
2597226016
"type": "boolean",
2597326017
"example": true,
2597426018
"nullable": true
@@ -26269,6 +26313,26 @@
2626926313
}
2627026314
}
2627126315
},
26316+
{
26317+
"properties": {
26318+
"entries": {
26319+
"description": "A list of collaborations",
26320+
"type": "array",
26321+
"items": {
26322+
"$ref": "#/components/schemas/Collaboration"
26323+
}
26324+
}
26325+
}
26326+
}
26327+
],
26328+
"title": "Collaborations",
26329+
"x-box-resource-id": "collaborations",
26330+
"x-box-tag": "user_collaborations"
26331+
},
26332+
"CollaborationsOffsetPaginated": {
26333+
"description": "A list of collaborations",
26334+
"type": "object",
26335+
"allOf": [
2627226336
{
2627326337
"type": "object",
2627426338
"description": "The part of an API response that describes pagination",
@@ -26290,30 +26354,6 @@
2629026354
"type": "integer",
2629126355
"format": "int64",
2629226356
"example": 2000
26293-
},
26294-
"order": {
26295-
"description": "The order by which items are returned.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.",
26296-
"type": "array",
26297-
"items": {
26298-
"type": "object",
26299-
"description": "The order in which a pagination is ordered",
26300-
"properties": {
26301-
"by": {
26302-
"description": "The field to order by",
26303-
"type": "string",
26304-
"example": "type"
26305-
},
26306-
"direction": {
26307-
"description": "The direction to order by, either ascending or descending",
26308-
"type": "string",
26309-
"example": "ASC",
26310-
"enum": [
26311-
"ASC",
26312-
"DESC"
26313-
]
26314-
}
26315-
}
26316-
}
2631726357
}
2631826358
}
2631926359
},
@@ -26330,7 +26370,7 @@
2633026370
}
2633126371
],
2633226372
"title": "Collaborations",
26333-
"x-box-resource-id": "collaborations",
26373+
"x-box-resource-id": "collaborations_offset_paginated",
2633426374
"x-box-tag": "user_collaborations"
2633526375
},
2633626376
"CollaboratorVariable": {
@@ -30809,6 +30849,84 @@
3080930849
"x-box-resource-id": "items",
3081030850
"x-box-tag": "folders"
3081130851
},
30852+
"ItemsOffsetPaginated": {
30853+
"description": "A list of files, folders, and web links in\ntheir mini representation.",
30854+
"type": "object",
30855+
"allOf": [
30856+
{
30857+
"type": "object",
30858+
"description": "The part of an API response that describes pagination",
30859+
"properties": {
30860+
"total_count": {
30861+
"description": "One greater than the offset of the last entry in the entire collection.\nThe total number of entries in the collection may be less than\n`total_count`.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.",
30862+
"type": "integer",
30863+
"format": "int64",
30864+
"example": 5000
30865+
},
30866+
"limit": {
30867+
"description": "The limit that was used for these entries. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed. The maximum value varies by API.",
30868+
"type": "integer",
30869+
"format": "int64",
30870+
"example": 1000
30871+
},
30872+
"offset": {
30873+
"description": "The 0-based offset of the first entry in this set. This will be the same\nas the `offset` query parameter.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.",
30874+
"type": "integer",
30875+
"format": "int64",
30876+
"example": 2000
30877+
},
30878+
"order": {
30879+
"description": "The order by which items are returned.\n\nThis field is only returned for calls that use offset-based pagination.\nFor marker-based paginated APIs, this field will be omitted.",
30880+
"type": "array",
30881+
"items": {
30882+
"type": "object",
30883+
"description": "The order in which a pagination is ordered",
30884+
"properties": {
30885+
"by": {
30886+
"description": "The field to order by",
30887+
"type": "string",
30888+
"example": "type"
30889+
},
30890+
"direction": {
30891+
"description": "The direction to order by, either ascending or descending",
30892+
"type": "string",
30893+
"example": "ASC",
30894+
"enum": [
30895+
"ASC",
30896+
"DESC"
30897+
]
30898+
}
30899+
}
30900+
}
30901+
}
30902+
}
30903+
},
30904+
{
30905+
"properties": {
30906+
"entries": {
30907+
"description": "The items in this collection.",
30908+
"type": "array",
30909+
"items": {
30910+
"oneOf": [
30911+
{
30912+
"$ref": "#/components/schemas/File--Full"
30913+
},
30914+
{
30915+
"$ref": "#/components/schemas/Folder--Mini"
30916+
},
30917+
{
30918+
"$ref": "#/components/schemas/WebLink"
30919+
}
30920+
]
30921+
}
30922+
}
30923+
}
30924+
}
30925+
],
30926+
"title": "Items",
30927+
"x-box-resource-id": "items_offset_paginated",
30928+
"x-box-tag": "folders"
30929+
},
3081230930
"KeywordSkillCard": {
3081330931
"description": "A skill card that contains a set of keywords",
3081430932
"type": "object",

0 commit comments

Comments
 (0)