r.2023.10.06.0
Summary:
- deprecate old settings endpoint
- bug fixes
What's Changed
- Turn fallback on for all labels unleash flag. by @myersCody in #4716
- [COST-4120] Fix capacity instance counts. by @myersCody in #4644
- [COST-3797] Deprecate Settings endpoint by @myersCody in #4670
- Fix flags.json by @myersCody in #4721
- Improve logging around ocp on cloud summary dates. by @myersCody in #4715
- [COST-4257] Fix unused percentage for first days of the month. by @myersCody in #4720
- Bump the worker timout for large customers by @lcouzens in #4719
Deprecation Notice
- Endpoint:
/api/cost-management/v1/settings/
- Deprecated:
Friday, Oct. 6th 2023
- End of Life:
Wednesday, Jan. 31st 2024
Overview
In this release, we are excited to announce a significant change regarding one of our API endpoints. We have moved the functionality in our Setting's workflow which was previously built on Data Driven Forms (DDF) to a new location. This transition enables us to pave the way for exciting new functionalities and improvements in future releases.
Key Changes
-
Endpoint Relocation: The endpoint that was previously built on DDF has been relocated to a new home within our system. This transition ensures better alignment with our evolving architecture and future development plans.
-
Improved Performance: With this move, we have optimized the endpoint's performance, resulting in faster response times and reduced latency.
-
Scalability: The new implementation is designed to scale seamlessly as our user base and data volume grow, ensuring a consistent and reliable experience.
How Does This Affect You?
For most users, this transition will be seamless, with no immediate action required. However, if you have direct integrations or dependencies on the previous endpoint, we recommend reviewing your configurations and updating them as needed to point to the new location. The functionalities available on the previous endpoint can still be controlled through their new locations:
1. Setting a Default AWS Cost Type
- Endpoint:
/api/cost-management/v1/account-settings/cost-type/
- Acceptable Methods:
[GET, PUT]
- Example Request Body:
{
"cost_type": "unblended_cost"
}
2. Setting a Default Currency
- Endpoint:
/api/cost-management/v1/account-settings/currency/
- Acceptable Methods:
[GET, PUT]
- Example Request Body:
{
"currency": "EUR"
}
NOTE: To see your currency options use:
/api/cost-management/v1/currency/
3. Enabling and Disabling Tags & Labels
- Endpoint to view tags:
/api/cost-management/v1/settings/tags/
- Acceptable Methods:
[GET]
- Example Response:
{
"meta": {
"count": 17,
"limit": 100,
"offset": 0
},
"links": {
"first": "/api/cost-management/v1/settings/tags/?limit=100&offset=0",
"next": null,
"previous": null,
"last": "/api/cost-management/v1/settings/tags/?limit=100&offset=0"
},
"data": [
{
"uuid": "a1e5d730-c987-4507-a333-439972f886d6",
"key": "app",
"enabled": true,
"source_type": "OCP"
}
]
}
NOTE: This endpoint will return a unique identifier,
a1e5d730-c987-4507-a333-439972f886d6
in the example above, which will be used in the following endpoints to control enablement:
- Endpoint to Enable:
/api/cost-management/v1/settings/tags/enable/
- Endpoint to Disable:
/api/cost-management/v1/settings/tags/disable/
- Acceptable Methods:
[PUT]
- Example Request Body:
- Acceptable Methods:
{
"ids": ["a1e5d730-c987-4507-a333-439972f886d6"]
}
4. Enabling and Disabling AWS Cost Categories
- Endpoint to view tags:
api/cost-management/v1/settings/aws_category_keys/
- Acceptable Methods:
[GET]
- Example Response:
{
"meta": {
"count": 17,
"limit": 100,
"offset": 0
},
"links": {
"first": "/api/cost-management/v1/settings/tags/?limit=100&offset=0",
"next": null,
"previous": null,
"last": "/api/cost-management/v1/settings/tags/?limit=100&offset=0"
},
"data": [
{
"uuid": "d75540f4-e030-4ce5-8782-a44ae25f2a17",
"key": "volume",
"enabled": true
},
{
"uuid": "46060dc7-a544-4fd0-be5b-880e1b37601d",
"key": "qe",
"enabled": true
},
]
}
NOTE: This endpoint will return a unique identifier,
d75540f4-e030-4ce5-8782-a44ae25f2a17
in the example above, which will be used in the following endpoints to control enablement:
- Endpoint to Enable:
/api/cost-management/v1/settings/aws_category_keys/enable/
- Endpoint to Disable:
/api/cost-management/v1/settings/aws_category_keys/disable/
- Acceptable Methods:
[PUT]
- Example Request Body:
- Acceptable Methods:
{
"ids": ["d75540f4-e030-4ce5-8782-a44ae25f2a17", "46060dc7-a544-4fd0-be5b-880e1b37601d""]
}
What's New?
Enhanced Response Headers
We have added new response headers to our API responses, specifically tailored to provide insights into upcoming deprecations. These headers are designed to assist you in staying ahead of any modifications to our APIs and help ensure a smooth transition.
Deprecation: Fri, 29 Sep 2023 00:00:00
- The date the endpoint is no longer supported.Sunset: Wed, 31 Jan 2024 00:00:00
- The date the endpoint will be permanently removed.
How Does This Benefit You?
By examining these response headers in your workflows and integrations, you can:
-
Stay Informed: Be notified in advance of any deprecations or breaking changes planned for our APIs.
-
Proactive Action: Take proactive measures to update your configurations and adapt to upcoming changes, minimizing potential disruptions to your operations.
Recommended Action
To leverage the benefits of these enhanced response headers, we recommend the following actions:
-
Review Your Integration: Take some time to review your existing integrations and workflows that rely on our APIs.
-
Check for New Headers: Ensure that your integrations are equipped to capture and interpret the new response headers.
-
Stay Updated: Periodically monitor these headers to receive timely notifications of any deprecations or changes.
-
Adjust as Needed: When you receive notifications related to upcoming deprecations, make the necessary adjustments to your configurations or code to align with the changes.
Conclusion
We are excited about the possibilities that this transition opens up for our platform. Our commitment to providing you with the best possible experience remains unwavering, and we look forward to delivering new functionalities and improvements in the near future.
Full Changelog: r.2023.10.03.0...r.2023.10.06.0