Secret Views

This module contains views to implement the Secret.

card-style detail view in the Smarter Dashboard.

class smarter.apps.secret.views.detailview.SecretDetailView(**kwargs)[source]

Bases: DocsBaseView

Renders the detail view for a Smarter dashboard secret.

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

Parameters:

  • request (ASGIRequest) – Django HTTP request object.

  • args (tuple) – Additional positional arguments.

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

Returns:

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

Return type:

HttpResponse

Note

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

See also

Secret for secret metadata retrieval. ApiV1CliDescribeApiView for API details.

Example usage:

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

Handle GET requests to render the secret manifest detail view.

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

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

Returns:

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

Return type:

HttpResponse

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