SPOTCON-37764 Updated OpenAPI documentation for Ocean Rightsizing Recommendation History API.#837
Open
cshivaraj-patil wants to merge 3 commits into
Conversation
…ommendation History API Updated OpenAPI documentation for Ocean Rightsizing Recommendation History API. Added endpoint definition, request parameters, response schema, examples, and aligned query parameter documentation with API behavior.
cshivaraj-patil
force-pushed
the
SPOTCON-37764-add-workload-recommendation-history-api-to-external-open-api-documentation
branch
from
97bacb9 to
99778a5
Compare
Ranjithdr21
requested changes
Jul 8, 2026
Ranjithdr21
left a comment
Ranjithdr21
left a comment
Contributor
There was a problem hiding this comment.
Please update the schema to match history api and also include limit field in that.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Jira ticket-
https://flexera.atlassian.net/browse/SPOTCON-37764
why
The workload recommendation history API was implemented but was not exposed in the external OpenAPI documentation. Documentation support was required so external consumers can discover and use the new endpoint.
What
Added external OpenAPI documentation for workload recommendation history endpoint.
Added endpoint definition:
GET /ocean/{oceanId}/rightSizing/namespaces/{namespace}/{workloadType}/{workloadName}/recommendation-history
Added request parameter documentation:
oceanId
namespace
workloadType
workloadName
accountId
fromDate
toDate
containerNames
Added response schema and response wrapper definitions.
Added request/response examples for recommendation history retrieval.
Aligned parameter requirements and examples with API implementation.
Checklist
-[x] I added a Jira ticket link
-[x] I filled in the test plan
-[x] I executed the tests and filled in the test results
-[x] My code follows the style guidelines of this project
-[x] I have performed a self-review of my own code
-[x] I have validated all the requirements in the Jira task were answered
How to test
Run:
yarn validate
Run:
yarn serve
Navigate to:
Ocean Automatic Rightsizing → Get Ocean Rightsizing Recommendation History
Validate:
Endpoint appears in documentation
Parameters are rendered correctly
Response schema is visible
Example request/response are displayed properly
test result
Validated endpoint appears under Ocean Automatic Rightsizing - passed.