-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DOC-2679-API-Right-Sizing-Choose-Percentile-Implementation-OpenAPI (#711
- Loading branch information
1 parent
f99f876
commit 2c84cea
Showing
4 changed files
with
80 additions
and
0 deletions.
There are no files selected for viewing
27 changes: 27 additions & 0 deletions
27
api/services/ocean/rightsizing/paths/oceanRightsizingClusterConfiguration.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
post: | ||
summary: "Set Cluster Recommendations Percentile" | ||
description: | | ||
Set Recommendations Percentile for the Ocean Cluster. | ||
<br /> | ||
<br /> | ||
**This action can take a few minutes to complete.** | ||
operationId: "SetClusterRecommendationsPercentile" | ||
tags: | ||
- "Ocean Automatic Rightsizing" | ||
parameters: | ||
- $ref: "../parameters/oceanId.yaml" | ||
- $ref: "../parameters/clusterIdentifier.yaml" | ||
- $ref: "../../../../commons/parameters/accountId.yaml" | ||
requestBody: | ||
required: true | ||
content: | ||
application/json: | ||
schema: | ||
allOf: | ||
- $ref: "../schemas/oceanRightsizingSetClusterRecommendationsPercentileRequest.yaml" | ||
responses: | ||
200: | ||
description: Ocean Cluster Recommendations Percentile Response | ||
$ref: "../responses/oceanRightsizingClusterConfigurationResponse.yaml" | ||
400: | ||
description: "Bad Request" |
37 changes: 37 additions & 0 deletions
37
api/services/ocean/rightsizing/responses/oceanRightsizingClusterConfigurationResponse.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
description: Ocean Rightsizing Cluster Configuration Response | ||
content: | ||
application/json: | ||
schema: | ||
allOf: | ||
- $ref: "../../../../commons/schemas/responseItemWrapper.yaml" | ||
- type: object | ||
properties: | ||
request: | ||
type: object | ||
properties: | ||
url: | ||
example: "/ocean/{oceanId}/rightSizing/cluster/configuration" | ||
method: | ||
example: "POST" | ||
response: | ||
type: object | ||
properties: | ||
items: | ||
type: array | ||
items: | ||
type: object | ||
properties: | ||
oceanId: | ||
type: string | ||
example: "o-abcd1234" | ||
clusterIdentifier: | ||
type: string | ||
example: "dev-cluster" | ||
config: | ||
type: object | ||
properties: | ||
recommendationsPercentile: | ||
type: integer | ||
example: 85 | ||
kind: | ||
example: "mcs:ocean:rightSizing:clusterConfiguration" |
14 changes: 14 additions & 0 deletions
14
...ocean/rightsizing/schemas/oceanRightsizingSetClusterRecommendationsPercentileRequest.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
type: object | ||
required: | ||
- config | ||
properties: | ||
config: | ||
type: object | ||
required: | ||
- recommendationsPercentile | ||
properties: | ||
recommendationsPercentile: | ||
type: integer | ||
description: Change the percentile that the right-sizing recommendations calculation will take into account. | ||
example: 85 | ||
enum: [ 85, 90, 95, 99 ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters