Detail View

This module contains views to implement the Provider.

card-style detail view in the Smarter Dashboard.

class smarter.apps.provider.views.detailview.ProviderDetailView(**kwargs)[source]

Bases: DocsBaseView

Renders the detail view for a Smarter dashboard provider.

This view renders a detailed manifest for a specific provider, including its configuration and metadata, in YAML format. It is intended for authenticated users and provides error handling for missing or unsupported provider kinds and names.

Parameters:

  • request (ASGIRequest) – Django HTTP request object.

  • args (tuple) – Additional positional arguments.

  • kwargs (dict) – Keyword arguments, must include ‘name’ (provider name) and ‘kind’ (provider type).

Returns:

Rendered HTML page with provider manifest details, or a 404 error page if the provider is not found or parameters are invalid.

Return type:

HttpResponse

Note

The provider name and kind must be provided and valid. Otherwise, a “not found” response is returned.

See also

Provider for provider metadata retrieval. ApiV1CliDescribeApiView for API details.

Example usage:

GET /provider/detail/?name=my_provider&kind=custom
get(request, *args, **kwargs)[source]

Handle GET requests to render the provider manifest detail view.

This method processes the incoming request to retrieve the specified provider’s manifest details and renders them in a user-friendly format. It performs validation on the provided provider name and kind, retrieves the provider metadata, and handles any errors that may arise during this process.

Process: 1. Extract and validate ‘name’ and ‘kind’ from kwargs. 2. Retrieve the provider metadata using the provided name and user context. 3. If the provider is found, call the API view to get the provider details 4. Convert the JSON response to YAML format for better readability. 5. Render the provider manifest detail template with the retrieved data. 6. Handle any errors that occur during the process and return appropriate error responses.

Parameters:

  • request (ASGIRequest) – Django HTTP request object.

  • args (tuple) – Additional positional arguments.

  • kwargs (dict) – Keyword arguments, must include ‘name’ (provider name) and ‘kind’ (provider type).

Returns:

Rendered HTML page with provider manifest details, or an error response if the provider is not found or parameters are invalid.

Return type:

HttpResponse

provider: Provider | None = None
template_path: str | None = 'common/manifest_detail.html'