DetailView

This module contains views to implement the AuthToken card-style detail view in the Smarter Dashboard.

class smarter.lib.drf.views.detailview.AuthTokenDetailView(*args, **kwargs)[source]

Bases: DocsBaseView

Renders the detail view for a Smarter dashboard authtoken.

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

Parameters:

  • request (ASGIRequest) – Django HTTP request object.

  • args (tuple) – Additional positional arguments.

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

Returns:

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

Return type:

HttpResponse

Note

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

See also

AuthToken for authtoken metadata retrieval. ApiV1CliDescribeApiView for API details.

Example usage:

GET /authtoken/detail/?name=my_authtoken&kind=custom
authtoken: SmarterAuthToken | None = None
get(request, *args, **kwargs)[source]

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

Process: 1. Extract and validate ‘name’ and ‘kind’ from kwargs. 2. Retrieve the authtoken metadata using the provided name and user context. 3. If the authtoken is found, call the API view to get the authtoken details 4. Convert the JSON response to YAML format for better readability. 5. Render the authtoken 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’ (authtoken name) and ‘kind’ (authtoken type).

Returns:

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

Return type:

HttpResponse

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