Checks catalog openapi

[nelsonkopliku]

Added Checks Catalog OpenApi documentation.

vokoscreenNG-2022-05-16_18-28-34.mp4

The flat option fits a bit strangely in the open api spec.
It might be worth considering making that more standard and actually making it a boolean.

• GET /api/hosts
• GET /api/clusters
• GET /api/sap_systems
• GET /api/databases
• GET /api/checks/catalog
• POST /api/clusters/:cluster_id/checks
• POST /api/clusters/:cluster_id/checks/request_execution
• POST /api/runner/callback

Follows up #512 #522 #528

[arbulu89]

Great!
I have noted some small issues to be corrected, together with other doubts.

[arbulu89]

Where is this SupportedProviders specified?

[nelsonkopliku]

That's defined in lib/trento_web/openapi/schema/provider.ex:7

defmodule SupportedProviders do
  @moduledoc false

  OpenApiSpex.schema(%{
    title: "SupportedProviders",
    type: :string,
    description: "Detected Provider where the resource is running",
    enum: [:azure, :aws, :gcp, :unknown]
  })
end

And now that I see it I think:

• should we consider default part of that list?
• is :unknown actually a SupportedProvider?

I believe we can iterate more on these details.

[arbulu89]

:unknown is not supported in the checks catalog. We have in the code as an incoming provider in hosts, as we will have hosts that are not running in our known providers, and they will have this value.
So, in this SupportedProviders I see it totally right.
default is not part of this list, as I don't see any provider option as default

[nelsonkopliku]

@arbulu89 Thanks for the review! Another pair of eyes is always beneficial especially with this kind of work 😅

Addressed your comments here f3b1404 and here ed5b4de

Should be good enough for now.

[arbulu89]

Ready to merge from my side!