Skip to content

Commit

Permalink
docs: Update collaboration resource (#483)
Browse files Browse the repository at this point in the history
  • Loading branch information
@box-apimgmt
box-apimgmt authored Nov 18, 2024
1 parent 966decb commit db58e26
Showing 1 changed file with 149 additions and 31 deletions.
180 changes: 149 additions & 31 deletions openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"url": "http://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2.0.0",
"x-box-commit-hash": "98d60db47f"
"x-box-commit-hash": "8edc17f8ac"
},
"servers": [
{
Expand Down Expand Up @@ -6252,6 +6252,28 @@
"name"
],
"explode": false
},
{
"name": "limit",
"in": "query",
"description": "The maximum number of items to return per page.",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"maximum": 1000
},
"example": 1000
},
{
"name": "marker",
"in": "query",
"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`.",
"required": false,
"schema": {
"type": "string"
},
"example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}
],
"responses": {
Expand Down Expand Up @@ -7839,6 +7861,28 @@
"format": "uuid"
},
"example": "01234500-12f1-1234-aa12-b1d234cb567e"
},
{
"name": "marker",
"in": "query",
"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`.",
"required": false,
"schema": {
"type": "string"
},
"example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
},
{
"name": "limit",
"in": "query",
"description": "The maximum number of items to return per page.",
"required": false,
"schema": {
"type": "integer",
"format": "int64",
"maximum": 1000
},
"example": 1000
}
],
"responses": {
Expand Down Expand Up @@ -10089,7 +10133,7 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Collaborations"
"$ref": "#/components/schemas/CollaborationsOffsetPaginated"
}
}
}
Expand Down Expand Up @@ -16347,7 +16391,7 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Collaborations"
"$ref": "#/components/schemas/CollaborationsOffsetPaginated"
}
}
}
Expand Down Expand Up @@ -17785,7 +17829,7 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Items"
"$ref": "#/components/schemas/ItemsOffsetPaginated"
}
}
}
Expand Down Expand Up @@ -25963,12 +26007,12 @@
"type": "object",
"properties": {
"enterprise_has_strong_password_required_for_external_users": {
"description": "Whether or not the enterprise that owns the content requires\na strong password to collaborate on the content.",
"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.",
"type": "boolean",
"example": true
},
"user_has_strong_password": {
"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.",
"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.",
"type": "boolean",
"example": true,
"nullable": true
Expand Down Expand Up @@ -26269,6 +26313,26 @@
}
}
},
{
"properties": {
"entries": {
"description": "A list of collaborations",
"type": "array",
"items": {
"$ref": "#/components/schemas/Collaboration"
}
}
}
}
],
"title": "Collaborations",
"x-box-resource-id": "collaborations",
"x-box-tag": "user_collaborations"
},
"CollaborationsOffsetPaginated": {
"description": "A list of collaborations",
"type": "object",
"allOf": [
{
"type": "object",
"description": "The part of an API response that describes pagination",
Expand All @@ -26290,30 +26354,6 @@
"type": "integer",
"format": "int64",
"example": 2000
},
"order": {
"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.",
"type": "array",
"items": {
"type": "object",
"description": "The order in which a pagination is ordered",
"properties": {
"by": {
"description": "The field to order by",
"type": "string",
"example": "type"
},
"direction": {
"description": "The direction to order by, either ascending or descending",
"type": "string",
"example": "ASC",
"enum": [
"ASC",
"DESC"
]
}
}
}
}
}
},
Expand All @@ -26330,7 +26370,7 @@
}
],
"title": "Collaborations",
"x-box-resource-id": "collaborations",
"x-box-resource-id": "collaborations_offset_paginated",
"x-box-tag": "user_collaborations"
},
"CollaboratorVariable": {
Expand Down Expand Up @@ -30809,6 +30849,84 @@
"x-box-resource-id": "items",
"x-box-tag": "folders"
},
"ItemsOffsetPaginated": {
"description": "A list of files, folders, and web links in\ntheir mini representation.",
"type": "object",
"allOf": [
{
"type": "object",
"description": "The part of an API response that describes pagination",
"properties": {
"total_count": {
"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.",
"type": "integer",
"format": "int64",
"example": 5000
},
"limit": {
"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.",
"type": "integer",
"format": "int64",
"example": 1000
},
"offset": {
"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.",
"type": "integer",
"format": "int64",
"example": 2000
},
"order": {
"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.",
"type": "array",
"items": {
"type": "object",
"description": "The order in which a pagination is ordered",
"properties": {
"by": {
"description": "The field to order by",
"type": "string",
"example": "type"
},
"direction": {
"description": "The direction to order by, either ascending or descending",
"type": "string",
"example": "ASC",
"enum": [
"ASC",
"DESC"
]
}
}
}
}
}
},
{
"properties": {
"entries": {
"description": "The items in this collection.",
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/File--Full"
},
{
"$ref": "#/components/schemas/Folder--Mini"
},
{
"$ref": "#/components/schemas/WebLink"
}
]
}
}
}
}
],
"title": "Items",
"x-box-resource-id": "items_offset_paginated",
"x-box-tag": "folders"
},
"KeywordSkillCard": {
"description": "A skill card that contains a set of keywords",
"type": "object",
Expand Down

0 comments on commit db58e26

Please sign in to comment.