diff --git a/api/services/ocean/rightsizing/schemas/oceanRightsizingSavings.yaml b/api/services/ocean/rightsizing/schemas/oceanRightsizingSavings.yaml index e4bbd787..9b743a83 100644 --- a/api/services/ocean/rightsizing/schemas/oceanRightsizingSavings.yaml +++ b/api/services/ocean/rightsizing/schemas/oceanRightsizingSavings.yaml @@ -5,6 +5,7 @@ description: > properties: totalSavingsSummary: #todo baruch - add description for the main objects type: object + description: A summary of the savings for all the workloads in the response properties: cpuWithOcean: type: number @@ -16,6 +17,7 @@ properties: type: number namespacesSavingsSummary: type: array + description: A summary of the savings for each namespace in the response items: type: object properties: @@ -25,6 +27,7 @@ properties: type: number workloadSavings: type: array + description: A list of the savings for each workload in the response items: type: object properties: diff --git a/api/services/ocean/rightsizing/schemas/oceanRightsizingSavingsWorkloadsRequest.yaml b/api/services/ocean/rightsizing/schemas/oceanRightsizingSavingsWorkloadsRequest.yaml index 6f0ac1b9..ca96149d 100644 --- a/api/services/ocean/rightsizing/schemas/oceanRightsizingSavingsWorkloadsRequest.yaml +++ b/api/services/ocean/rightsizing/schemas/oceanRightsizingSavingsWorkloadsRequest.yaml @@ -1,17 +1,30 @@ -type: object title: Ocean Right-Sizing Savings Workloads description: > Determines the Ocean Savings filtering by the combinations of namespace::workload +type: object properties: namespaceName: - description: Determines the namespace to filter with an array of its workloads - type: array - items: - type: string - properties: - workloadName: - type: string #todo baruch - change to workload object with workload type -example: { - namespaceName1: [ "workloadName1", "workloadName1" ], - namespaceName2: [ "workloadName1", "workloadName1" ] -} + type: object + additionalProperties: + type: array + items: + type: object + properties: #todo baruch + workloadName: + type: string + description: The name of the workload + workloadType: + type: string + description: The type of the workload (e.g., Deployment, DaemonSet, StatefulSet) + +example: + namespaceName1: + - workloadName: workloadName1 + workloadType: Deployment + - workloadName: workloadName2 + workloadType: DaemonSet + namespaceName2: + - workloadName: workloadName3 + workloadType: StatefulSet + - workloadName: workloadName4 + workloadType: Deployment