lib/plausible_web/plugins/api/schemas/shared_link.ex

defmodule PlausibleWeb.Plugins.API.Schemas.SharedLink do
  @moduledoc """
  OpenAPI schema for SharedLink object
  """
  use PlausibleWeb, :open_api_schema

  OpenApiSpex.schema(%{
    description: "Shared Link object",
    type: :object,
    required: [:shared_link],
    properties: %{
      shared_link: %Schema{
        type: :object,
        required: [:id, :name, :password_protected, :href],
        properties: %{
          id: %Schema{type: :integer, description: "Shared Link ID"},
          name: %Schema{type: :string, description: "Shared Link Name"},
          password_protected: %Schema{
            type: :boolean,
            description: "Shared Link Has Password"
          },
          href: %Schema{type: :string, description: "Shared Link URL"}
        }
      }
    },
    example: %{
      shared_link: %{
        id: 1024,
        name: "Public Dashboard",
        password_protected: false,
        href: "https://example.com"
      }
    }
  })
end