hccdoc-2065 update description and auth description #4877
Conversation
|
Can one of the admins verify this patch? |
docs/specs/openapi.json
Outdated
| @@ -1,7 +1,7 @@ | |||
| { | |||
| "openapi": "3.0.0", | |||
| "info": { | |||
| "description": "The API for Cost Management", | |||
| "description": "Access your cloud and OpenShift data you integrated with cost management.", | |||
| "version": "1.0.2", | |||
There was a problem hiding this comment.
Could you also set this version to v1? I have no idea where 1.0.2 came from, and given that our api path is api/cost-management/v1, it feels like this version should also be v1.
There was a problem hiding this comment.
I changed to v 1 with no dots. Does it need to be 1.0.0?
I'm editing the right openapi file right? The only other ones are in /koku/sources and /koku/masu and look like they do different stuff.
There was a problem hiding this comment.
I think it should be v1. And yes, this is the correct doc to edit.
There was a problem hiding this comment.
There seems to be zero consistency, but looking at this one:
https://console.redhat.com/docs/api/compliance
it uses v1.
There was a problem hiding this comment.
Ok, updated to "v1"
maskarb
added
hot-fix-smoke-tests
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #4877 +/- ##
=====================================
Coverage 94.0% 94.0%
=====================================
Files 372 372
Lines 30679 30679
Branches 3658 3658
=====================================
+ Hits 28846 28848 +2
+ Misses 1169 1166 -3
- Partials 664 665 +1 |
|
/retest |
| @@ -6103,7 +6103,7 @@ | |||
| "securitySchemes": { | |||
There was a problem hiding this comment.
@maskarb Will this securitySchemes be updated as the basic auth moves to service account auth?
There was a problem hiding this comment.
I had not thought about that at all, but it will probably need to, yes.
Jira Ticket
HCCDOC-2065
Description
This change will update the main description and the description of the Auth section, although I think the auth section needs to be updated from basic to service token.
Testing
Notes
...