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

[version-4-5] docs: update edge managament api for 4.5.5 (#4486) #4487

Closed
wants to merge 1 commit into from
Closed

[version-4-5] docs: update edge managament api for 4.5.5 (#4486) #4487

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
124 changes: 121 additions & 3 deletions docs/api-content/api-docs/edge-v1/emc-api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,13 @@
}
},
"patch": {
"description": "Updates a cluster with the provided cluster configuration",
"description": "DEPRECATED - This endpoint is deprecated and will be removed in future versions. Use /v1/edge-mgmt/cluster/{clusterName} instead",
"tags": [
"edge-mgmt"
],
"summary": "Updates a cluster with the provided cluster configuration",
"operationId": "v1UpdateCluster",
"summary": "DEPRECATED - This endpoint is deprecated and will be removed in future versions. Use /v1/edge-mgmt/cluster/{clusterName} instead",
"operationId": "v1PatchCluster",
"deprecated": true,
"parameters": [
{
"name": "body",
Expand Down Expand Up @@ -400,6 +401,86 @@
}
}
},
"/v1/edge-mgmt/cluster/{clusterName}": {
"put": {
"description": "Updates a cluster with the provided cluster configuration",
"tags": [
"edge-mgmt"
],
"summary": "Updates a cluster with the provided cluster configuration",
"operationId": "v1UpdateClusterConfig",
"parameters": [
{
"type": "string",
"description": "Name of the cluster to be updated",
"name": "clusterName",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ClusterConfiguration"
}
}
],
"responses": {
"202": {
"description": "(empty)",
"schema": {
"$ref": "#/definitions/v1AcceptedResponseWithMessage"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/v1Error"
}
}
}
},
"patch": {
"description": "Patch a cluster with the provided cluster configuration",
"tags": [
"edge-mgmt"
],
"summary": "Patch a cluster with the provided cluster configuration",
"operationId": "v1PatchClusterConfig",
"parameters": [
{
"type": "string",
"description": "Name of the cluster to be patched",
"name": "clusterName",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ClusterPatch"
}
}
],
"responses": {
"202": {
"description": "(empty)",
"schema": {
"$ref": "#/definitions/v1AcceptedResponseWithMessage"
}
},
"500": {
"description": "Internal server error",
"schema": {
"$ref": "#/definitions/v1Error"
}
}
}
}
},
"/v1/edge-mgmt/clusters/archive/embedded/details": {
"get": {
"description": "parses the cluster-config archive.",
Expand Down Expand Up @@ -2048,6 +2129,17 @@
}
}
},
"v1ClusterPatch": {
"type": "object",
"properties": {
"clusterConfigPatches": {
"type": "array",
"items": {
"$ref": "#/definitions/v1HttpPatch"
}
}
}
},
"v1ClusterProfileConfiguration": {
"description": "v1ClusterProfileConfiguration is the configuration required to update a cluster's profiles.",
"type": "object",
Expand Down Expand Up @@ -3063,6 +3155,32 @@
}
}
},
"v1HttpPatch": {
"type": "object",
"required": [
"op",
"path"
],
"properties": {
"op": {
"description": "The operation to be performed",
"type": "string",
"enum": [
"add",
"remove",
"replace"
]
},
"path": {
"description": "A path to the pointer on which operation will be done",
"type": "string"
},
"value": {
"description": "The value to be used within the operations.",
"type": "object"
}
}
},
"v1InternalServerError": {
"description": "Internal Server Error"
},
Expand Down