opencost icon indicating copy to clipboard operation
opencost copied to clipboard

Create OpenAPI / Swagger docs

Open dwbrown2 opened this issue 2 years ago • 2 comments

Goal is to help end users as well as those implementing the OpenCost spect better understand API definition.

More detailed proposal: https://docs.google.com/document/d/1BbuJgh9ToQNa_4mnjxG--enAO2_vmIsrkfWxJR-JGIA/edit

dwbrown2 avatar Sep 07 '22 03:09 dwbrown2

What API should we start with? I see you have an aggregation-related one defined. Start there?

The API response that Fairwinds uses is different from what you've defined in the above doc, but should have similar data points. I will try and get a copy of that.

jpelletier1 avatar Sep 07 '22 18:09 jpelletier1

I'd vote we start with the Allocation API! Can discuss more in community meeting tomorrow if that sounds good.

dwbrown2 avatar Sep 08 '22 03:09 dwbrown2