verify_api_v1_cli_endpoints

utility for running api/v1 cli endpoints to verify that they work.

class smarter.apps.api.management.commands.verify_api_v1_cli_endpoints.Command(*args, **kwargs)[source]

Bases: SmarterCommand

Management command for verifying the functionality of api/v1/cli/ endpoints in the Smarter platform.

This command is designed as both a utility and an instructional tool, allowing developers and administrators to manually exercise and validate the API endpoints that are typically covered by automated unit tests. It provides formatted output to facilitate understanding and trouble shooting.

Key Features and Demonstrations:

Shows how to generate an API key for a user, which is required for authenticated API requests.
Demonstrates how to include the API key in HTTP requests to api/v1/cli/ endpoints.
Explains how to construct and send HTTP requests to various CLI endpoints, including manifest application and plugin operations.
Illustrates how to handle and interpret the response objects returned by the API, with formatted output for clarity.

Usage:

This command is intended to be run via Django’s manage.py interface. It accepts a Smarter account number and a username, retrieves the corresponding user and account, and then performs a series of API endpoint verifications using a single-use API token. The command outputs detailed information about the environment, account, user, and API responses.

Workflow:

Validates the provided account and user information.
Generates a single-use API token for authentication.
Constructs and sends requests to one or more CLI endpoints, displaying the request URLs and responses.
Cleans up by deleting the temporary API token after use.

Intended Audience:

Developers, QA engineers, and system administrators who need to manually verify API endpoint behavior, troubleshoot issues, or learn how to interact with the Smarter CLI endpoints programmatically. This command is especially useful for demonstrations, manual testing, and instructional purposes.