You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
analytics/lib/plausible_web/plugins/api/schemas/capabilities.ex

40 lines
1.0 KiB
Elixir

defmodule PlausibleWeb.Plugins.API.Schemas.Capabilities do
@moduledoc """
OpenAPI schema for Capabilities
"""
use PlausibleWeb, :open_api_schema
require Plausible.Billing.Feature
@features Plausible.Billing.Feature.list_short_names()
@features_schema Enum.reduce(@features, %{}, fn feature, acc ->
Map.put(acc, feature, %Schema{type: :boolean})
end)
OpenApiSpex.schema(%{
title: "Capabilities",
description: "Capabilities object",
type: :object,
required: [:authorized, :data_domain, :features],
properties: %{
authorized: %Schema{type: :boolean},
data_domain: %Schema{type: :string, nullable: true},
features: %Schema{
type: :object,
required: @features,
properties: @features_schema
}
},
example: %{
authorized: true,
data_domain: "example.com",
features: %{
Funnels: false,
Goals: true,
Props: false,
RevenueGoals: false,
StatsAPI: false
}
}
})
end