public

Return public dashboard meta, a lazy expansion-factor block, or a full bundle.

Args: request (Any): DRF request with optional section / grouping / period / full query parameters.

Returns: Any: DRF Response with JSON payload and Cache-Control headers.

Examples:

PublicClusterDashboardAggregateView().get(None) # doctest: +SKIP

get/api/pub/cluster-dashboard/

Request

  • The document declares no server URL.
  • Auth: none declared

Query parameters

fullinteger

1 to return legacy full bundle

grouping'monthly' | 'yearly'

Lazy grouping. Required with section/period. monthly expects YYYY-MM; yearly expects YYYY.

periodstring

Lazy period key. Required with section/grouping. Format YYYY-MM for monthly or YYYY for yearly.

section'expansion_factor'

Lazy section. When present, grouping and period are required. Only expansion_factor is supported.

Response

statusstring
machine_namestring
detailstring nullable
retry_hintstring nullable
schema_versioninteger
sectionstring
groupingstring
period_keystring
expansion_factorsobject

Changes

    • breaking

      the query request parameter grouping was restricted to a list of enum values

    • breaking

      the query request parameter section was restricted to a list of enum values

    • breaking

      added the pattern ^(\d{4}|\d{4}-(0[1-9]|1[0-2]))$ to the query request parameter period

    • info

      added the new enum value expansion_factor to the query request parameter section

    • info

      added the new enum value monthly to the query request parameter grouping

    • info

      added the new enum value yearly to the query request parameter grouping

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed from the / response property allOf list for the response status

    • info

      removed from the // response property allOf list for the response status