Skip to content

SOD-7837 Updated the Ocean Right-Sizing Savings OpenAPI documentation.#838

Merged
cshivaraj-patil merged 2 commits into
masterfrom
SOD-7837-get-ocean-right-sizing-savings-open-api-documentation-is-incorrect
Jul 16, 2026
Merged

SOD-7837 Updated the Ocean Right-Sizing Savings OpenAPI documentation.#838
cshivaraj-patil merged 2 commits into
masterfrom
SOD-7837-get-ocean-right-sizing-savings-open-api-documentation-is-incorrect

Conversation

@cshivaraj-patil

@cshivaraj-patil cshivaraj-patil commented Jul 14, 2026

Copy link
Copy Markdown
Collaborator

Jira

https://flexera.atlassian.net/browse/SOD-7837

Summary

This PR updates the OpenAPI documentation for the Get Ocean Right-Sizing Savings endpoint to match the current API implementation.

Changes

  • Added the required clusterIdentifier field to the request schema.
  • Renamed the workload attribute from workloadName to name in the request and response schemas.
  • Renamed the response field from isDeleted to workloadDeleted.
  • Updated request and response examples to reflect the latest schema.
  • Fixed the response example to use valid boolean values.

Validation

  • Verified the OpenAPI specification is valid.
  • Confirmed the generated documentation reflects the updated request and response structures.

Demo

before updating-
Screenshot 2026-07-14 at 8 31 01 AM
Screenshot 2026-07-14 at 8 30 40 AM

after updating-
Screenshot 2026-07-14 at 8 30 09 AM
Screenshot 2026-07-14 at 8 29 23 AM

… to align with the current API implementation.

Added the required clusterIdentifier field to the request schema.
Renamed workloadName to name and isDeleted to workloadDeleted.
Updated the request/response schemas and examples to match the current API implementation.
@cshivaraj-patil
cshivaraj-patil requested a review from a team as a code owner July 14, 2026 03:08
@cshivaraj-patil cshivaraj-patil self-assigned this Jul 14, 2026
@cshivaraj-patil
cshivaraj-patil merged commit 0e1f67f into master Jul 16, 2026
5 checks passed
@cshivaraj-patil
cshivaraj-patil deleted the SOD-7837-get-ocean-right-sizing-savings-open-api-documentation-is-incorrect branch July 16, 2026 05:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants