Skip to content

Commit

Permalink
DOC-2679-API-Right-Sizing-Choose-Percentile-Implementation-OpenAPI (#711
Browse files Browse the repository at this point in the history
)

* Add the option to set the recommendation percentile for the recommendations via the API
  • Loading branch information
yagiloNetapp authored Jan 2, 2025
1 parent f99f876 commit 2c84cea
Show file tree
Hide file tree
Showing 4 changed files with 80 additions and 0 deletions.
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"
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"
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 ]
2 changes: 2 additions & 0 deletions api/spot.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -933,6 +933,8 @@ paths:
$ref: services/ocean/rightsizing/paths/oceanRightsizingRollbacks.yaml
/ocean/{oceanId}/rightSizing/rollbacks/acknowledge:
$ref: services/ocean/rightsizing/paths/oceanRightsizingAcknowledgeRollbacks.yaml
/ocean/{oceanId}/rightSizing/cluster/configuration:
$ref: services/ocean/rightsizing/paths/oceanRightsizingClusterConfiguration.yaml
/security/v1/compliances:
$ref: services/security/v1/paths/compliances.yaml
/security/v1/compliances/count:
Expand Down

0 comments on commit 2c84cea

Please sign in to comment.