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.

Sign up for GitHub

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

Jump to bottom

feat: add docs improvements and marker pagination #429

Closed
wants to merge 1 commit into from
Closed

feat: add docs improvements and marker pagination #429

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
137 changes: 132 additions & 5 deletions openapi.json
View file
Open in desktop
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": ""
"x-box-commit-hash": "7104f08bd4"
},
"servers": [
{
Expand Down Expand Up @@ -19496,7 +19496,7 @@
],
"x-box-tag": "file_version_retentions",
"summary": "List file version retentions",
"description": "Retrieves all file version retentions for the given enterprise.",
"description": "Retrieves all file version retentions for the given enterprise.\n\n**Note**:\nFile retention API is now **deprecated**. \nTo get information about files and file versions under retention,\nsee [files under retention](e://get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](e://get-retention-policy-assignments-id-file-versions-under-retention) endpoints.",
"parameters": [
{
"name": "file_id",
Expand Down Expand Up @@ -19702,7 +19702,7 @@
],
"x-box-tag": "file_version_retentions",
"summary": "Get retention on file",
"description": "Returns information about a file version retention.",
"description": "Returns information about a file version retention.\n\n**Note**:\nFile retention API is now **deprecated**. \nTo get information about files and file versions under retention,\nsee [files under retention](e://get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](e://get-retention-policy-assignments-id-file-versions-under-retention) endpoints.",
"parameters": [
{
"name": "file_version_retention_id",
Expand Down Expand Up @@ -25616,6 +25616,30 @@
"x-box-tag": "user_collaborations",
"description": "A list of collaborations",
"allOf": [
{
"type": "object",
"description": "The part of an API response that describes marker\nbased pagination",
"properties": {
"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.",
"example": 1000,
"type": "integer",
"format": "int64"
},
"next_marker": {
"description": "The marker for the start of the next page of results.",
"example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
"type": "string",
"nullable": true
},
"prev_marker": {
"description": "The marker for the start of the previous page of results.",
"example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"description": "The part of an API response that describes pagination",
Expand Down Expand Up @@ -26600,6 +26624,9 @@
},
{
"$ref": "#/components/schemas/GenericSource"
},
{
"$ref": "#/components/schemas/AppItemEventSource"
}
]
},
Expand Down Expand Up @@ -28269,7 +28296,7 @@
"type": "object",
"x-box-resource-id": "file_version_retention",
"x-box-tag": "file_version_retentions",
"description": "A retention policy blocks permanent deletion of content\nfor a specified amount of time. Admins can apply policies to\nspecified folders, or an entire enterprise. A file version retention\nis a record for a retained file version. To use this feature,\nyou must have the manage retention policies scope enabled for your\nAPI key via your application management console. For more information\nabout retention policies, please visit our help documentation",
"description": "A retention policy blocks permanent deletion of content\nfor a specified amount of time. Admins can apply policies to\nspecified folders, or an entire enterprise. A file version retention\nis a record for a retained file version. To use this feature,\nyou must have the manage retention policies scope enabled for your\nAPI key in your application management console.\n\n**Note**:\nFile retention API is now **deprecated**. \nTo get information about files and file versions under retention,\nsee [files under retention](e://get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](e://get-retention-policy-assignments-id-file-versions-under-retention) endpoints.",
"properties": {
"id": {
"type": "string",
Expand Down Expand Up @@ -28333,7 +28360,7 @@
"type": "object",
"x-box-resource-id": "file_version_retentions",
"x-box-tag": "file_version_retentions",
"description": "A list of file version retentions.",
"description": "A list of file version retentions.\n\n**Note**:\nFile retention API is now **deprecated**. \nTo get information about files and file versions under retention,\nsee [files under retention](e://get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](e://get-retention-policy-assignments-id-file-versions-under-retention) endpoints.",
"allOf": [
{
"type": "object",
Expand Down Expand Up @@ -29884,6 +29911,30 @@
"x-box-tag": "folders",
"description": "A list of files, folders, and web links in\ntheir mini representation.",
"allOf": [
{
"type": "object",
"description": "The part of an API response that describes marker\nbased pagination",
"properties": {
"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.",
"example": 1000,
"type": "integer",
"format": "int64"
},
"next_marker": {
"description": "The marker for the start of the next page of results.",
"example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
"type": "string",
"nullable": true
},
"prev_marker": {
"description": "The marker for the start of the previous page of results.",
"example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"description": "The part of an API response that describes pagination",
Expand Down Expand Up @@ -35266,6 +35317,30 @@
"x-box-tag": "users",
"description": "A list of users.",
"allOf": [
{
"type": "object",
"description": "The part of an API response that describes marker\nbased pagination",
"properties": {
"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.",
"example": 1000,
"type": "integer",
"format": "int64"
},
"next_marker": {
"description": "The marker for the start of the next page of results.",
"example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
"type": "string",
"nullable": true
},
"prev_marker": {
"description": "The marker for the start of the previous page of results.",
"example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"description": "The part of an API response that describes pagination",
Expand Down Expand Up @@ -37120,6 +37195,58 @@
}
}
},
"AppItemEventSource": {
"title": "AppItem Event source",
"type": "object",
"x-box-resource-id": "app_item_event_source",
"description": "The AppItem that triggered an event in the event stream.",
"required": [
"id",
"type",
"app_item_type"
],
"properties": {
"id": {
"type": "string",
"description": "The id of the AppItem",
"example": "6374669741"
},
"type": {
"type": "string",
"nullable": false,
"enum": [
"app_item"
],
"description": "The type of the source that this event represents. Can be only `app_item`.\n",
"example": "app_item"
},
"app_item_type": {
"type": "string",
"description": "The type of the AppItem",
"example": "hubs"
},
"user": {
"allOf": [
{
"$ref": "#/components/schemas/User--Mini"
},
{
"description": "The user that triggered the event."
}
]
},
"group": {
"allOf": [
{
"$ref": "#/components/schemas/Group--Mini"
},
{
"description": "The group that triggered the event."
}
]
}
}
},
"KeywordSkillCard": {
"type": "object",
"x-box-resource-id": "keyword_skill_card",
Expand Down
Loading