Skip to content

Commit

Permalink
fix: Remove Classification Deletion API, update `additionalProperties…
Browse files Browse the repository at this point in the history 
…` parameter (#380)
  • Loading branch information
@box-apimgmt
box-apimgmt authored Nov 21, 2023
1 parent 4a05323 commit 80102bd
Showing 1 changed file with 58 additions and 149 deletions.
207 changes: 58 additions & 149 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": "80879af1ee"
"x-box-commit-hash": "9e8bda337c"
},
"servers": [
{
Expand Down Expand Up @@ -3660,11 +3660,17 @@
"name": "Aaron Levie"
},
"additionalProperties": {
"type": "string",
"description": "A value for each of the fields that are present on the metadata\ntemplate.\n\nFor the `global.properties` template this can be an a list of zero\nor more fields, as this template allows for any generic key-value\npairs to be stored on the template.",
"example": "Aaron Levie",
"x-box-example-key": "name"
}
"allOf": [
{},
{
"example": "Aaron Levie"
},
{
"description": "A value for each of the fields that are present\non the metadata template.\nFor the `global.properties` template this can be\na list of zero or more fields,\nas this template allows for any generic key-value pairs \nto be stored stored in the template."
}
]
},
"x-box-example-key": "name"
}
}
}
Expand All @@ -3675,7 +3681,7 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Metadata"
"$ref": "#/components/schemas/Metadata--Full"
}
}
}
Expand Down Expand Up @@ -3818,7 +3824,7 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Metadata"
"$ref": "#/components/schemas/Metadata--Full"
}
}
}
Expand Down Expand Up @@ -6761,11 +6767,17 @@
"name": "Aaron Levie"
},
"additionalProperties": {
"type": "string",
"description": "A value for each of the fields that are present on the metadata\ntemplate.\n\nFor the `global.properties` template this can be an a list of zero\nor more fields, as this template allows for any generic key-value\npairs to be stored on the template.",
"example": "Aaron Levie",
"x-box-example-key": "name"
}
"allOf": [
{},
{
"example": "Aaron Levie"
},
{
"description": "A value for each of the fields that are present on the metadata\ntemplate.\nFor the `global.properties` template this can be a list of zero\nor more fields, as this template allows for any generic key-value\npairs to be stored in the template."
}
]
},
"x-box-example-key": "name"
}
}
}
Expand All @@ -6776,7 +6788,7 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Metadata"
"$ref": "#/components/schemas/Metadata--Full"
}
}
}
Expand Down Expand Up @@ -6920,7 +6932,7 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Metadata"
"$ref": "#/components/schemas/Metadata--Full"
}
}
}
Expand Down Expand Up @@ -7728,31 +7740,6 @@
}
}
}
},
"delete": {
"operationId": "delete_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema",
"summary": "Delete all classifications",
"tags": [
"Classifications"
],
"x-box-tag": "classifications",
"x-box-sanitized": true,
"description": "Delete all classifications by deleting the classification\nmetadata template.",
"responses": {
"204": {
"description": "Returns an empty response when the metadata\ntemplate for classifications is successfully deleted."
},
"default": {
"description": "An unexpected client error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientError"
}
}
}
}
}
}
},
"/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add": {
Expand Down Expand Up @@ -8022,102 +8009,6 @@
}
}
},
"/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#delete": {
"put": {
"operationId": "put_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema#delete",
"summary": "Delete classification",
"tags": [
"Classifications"
],
"x-box-tag": "classifications",
"x-box-sanitized": true,
"description": "Removes a classification from the list of classifications\navailable to the enterprise.\n\nThis API can also be called by including the enterprise ID in the\nURL explicitly, for example\n`/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema`.",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"description": "An array that contains one or more classifications to remove.",
"type": "array",
"items": {
"type": "object",
"description": "A single classification to remove.",
"required": [
"op",
"fieldKey",
"enumOptionKey"
],
"properties": {
"op": {
"type": "string",
"example": "removeEnumOption",
"description": "The type of change to perform on the classification\nobject.",
"enum": [
"removeEnumOption"
]
},
"fieldKey": {
"type": "string",
"example": "Box__Security__Classification__Key",
"description": "Defines classifications \navailable in the enterprise.",
"enum": [
"Box__Security__Classification__Key"
]
},
"enumOptionKey": {
"type": "string",
"example": "Sensitive",
"description": "The label of the classification to remove."
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Returns the updated `securityClassification` metadata template, which\ncontains a `Box__Security__Classification__Key` field that lists all\nthe classifications available to this enterprise.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClassificationTemplate"
}
}
}
},
"400": {
"description": "Returned if any of the request parameters are not valid.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientError"
}
}
}
},
"404": {
"description": "Returned when a template name is not correct. Please make sure\nthe URL for the request is correct.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientError"
}
}
}
},
"default": {
"description": "An unexpected client error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientError"
}
}
}
}
}
}
},
"/metadata_templates/{scope}/{template_key}/schema": {
"get": {
"operationId": "get_metadata_templates_id_id_schema",
Expand Down Expand Up @@ -8273,9 +8164,15 @@
"name": "Aaron Levie"
},
"additionalProperties": {
"type": "string",
"description": "The value of a custom data entry.",
"example": "Aaron Levie",
"allOf": [
{},
{
"example": "Aaron Levie"
},
{
"description": "A value for each of the fields that are present\non the metadata template.\nFor the `global.properties` template this can be\na list of zero or more fields,\nas this template allows for any generic key-value pairs \nto be stored stored in the template."
}
],
"x-box-example-key": "name"
}
},
Expand Down Expand Up @@ -25342,6 +25239,10 @@
"x-box-resource-id": "collaboration",
"x-box-tag": "user_collaborations",
"description": "Collaborations define access permissions for users and groups to files and\nfolders, similar to access control lists. A collaboration object grants a\nuser or group access to a file or folder with permissions defined by a\nspecific role.",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
Expand Down Expand Up @@ -29786,7 +29687,7 @@
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/File--Mini"
"$ref": "#/components/schemas/File--Full"
},
{
"$ref": "#/components/schemas/Folder--Mini"
Expand Down Expand Up @@ -30186,8 +30087,15 @@
},
{
"additionalProperties": {
"type": "string",
"example": "Aaron Levie",
"allOf": [
{},
{
"example": "Aaron Levie"
},
{
"description": "A value for each of the fields that are present\non the metadata template.\nFor the `global.properties` template this can be\na list of zero or more fields,\nas this template allows for any generic key-value pairs \nto be stored stored in the template."
}
],
"x-box-example-key": "name"
}
}
Expand Down Expand Up @@ -30504,7 +30412,8 @@
"x-box-tag": "metadata_templates",
"description": "A template for metadata that can be applied to files and folders",
"required": [
"type"
"type",
"id"
],
"properties": {
"id": {
Expand Down Expand Up @@ -30789,10 +30698,10 @@
{
"oneOf": [
{
"$ref": "#/components/schemas/File"
"$ref": "#/components/schemas/File--Full"
},
{
"$ref": "#/components/schemas/Folder"
"$ref": "#/components/schemas/Folder--Full"
},
{
"$ref": "#/components/schemas/WebLink"
Expand Down Expand Up @@ -32085,10 +31994,10 @@
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/File"
"$ref": "#/components/schemas/File--Full"
},
{
"$ref": "#/components/schemas/Folder"
"$ref": "#/components/schemas/Folder--Full"
},
{
"$ref": "#/components/schemas/WebLink"
Expand Down Expand Up @@ -32173,10 +32082,10 @@
{
"oneOf": [
{
"$ref": "#/components/schemas/File"
"$ref": "#/components/schemas/File--Full"
},
{
"$ref": "#/components/schemas/Folder"
"$ref": "#/components/schemas/Folder--Full"
},
{
"$ref": "#/components/schemas/WebLink"
Expand Down

0 comments on commit 80102bd

Please sign in to comment.