Creates Cloud Cost Trends API doc, updates Allocation Trends content #835
Conversation
|
Doc won't render as intended in GH's MD preview, but if you select Show all checks, GitBook has a preview that will show you what the doc will display as |
|
|
||
| ## Using the `names` parameter | ||
|
|
||
| `names` is a mandatory parameter which determines the sequence of items returned, based on whatever the query is aggregating by. For example, when `aggregateBy=provider`, the user should provide a comma-separated list of all items they which to see trend values for in this category. In this case, they should provide `names=AWS,GCP,Azure` to receive a list of trend values for all three providers. `service` is the default value for `AggregateBy`, so if the user does not provide a value for `aggregateBy`, they must still use the names parameter to list all services requested. For example, `names=AmazonEC2,AmazonS3,Microsoft.Compute...`. |
There was a problem hiding this comment.
The actual parameter for aggregation is aggregate not aggregateBy
|
|
||
| The equation for calculating `value` is: `value=window/comparisonWindow - 1` | ||
|
|
||
| Receiving a positive `value` means your `window` has increased compared to `comparisonWindow`. A negative `value` means spending has decreased. |
There was a problem hiding this comment.
Should this be something like "Receiving a positive value means your spending has increased in window compared to comparisonWindow ..."? As it is reads kind of strange to me
| {% endswagger-parameter %} | ||
|
|
||
| {% swagger-parameter in="path" name="aggregate" type="string" required="false" %} | ||
| Field by which to aggregate the results. Accepts: `invoiceEntityID`, `accountID`, `provider`, `service`, and `label:<name>`. Supports multi-aggregation using comma-separated lists, such as `aggregate=accountID,service`. Defaults to `service`. |
There was a problem hiding this comment.
I'm realizing now that we actually support more than this and that the default is not actually service but an empty string. Using an empty string for aggregate would cause us to aggregate by item.
As for a list of acceptable aggregate parameters, we can take invoiceEntityID, accountID, provider, providerID, category, service, and label:<name>
There was a problem hiding this comment.
So if they don't provide a value for aggregate, they will have to list every single line item in Names for a complete breakdown of their trends?
Related issue
Proposed Changes
Dev PR at https://github.com/kubecost/kubecost-cost-model/pull/1937