fake-api-server.ci.surveillance.model¶
This sub-package focuses on managing configuration keys and environment variables essential for the Fake API Server Surveillance system.
It provides structured enumerations for various configuration settings related to API servers, Git operations, GitHub integrations, and CI/CD workflows. These enumerations ensure consistent use of keys throughout the application and promote maintainability by avoiding hardcoded values.
ConfigurationKey
¶
Bases: Enum
Enumeration containing configuration keys used across the system.
Provides a structured set of constants for easy reference and reuse within the application. This enumeration encapsulates keys for API documentation, Fake-API-Server settings, Git information, GitHub pull request details, and configurations for various subcommands or CI operations.
Usage of this class promotes consistency and reduces hardcoding of string literals in the application code, ensuring easier maintenance and clarity.
| ATTRIBUTE | DESCRIPTION |
|---|---|
API_DOC_URL |
URL reference for accessing the API documentation.
|
FAKE_API_SERVER |
Key representing a fake API server setting.
|
SERVER_TYPE |
Key representing the type of server.
|
SUBCMD |
Subcommand identifier for configurations.
|
PULL |
Key identifying pull-related operations or subcommands.
|
ARGS |
Key for command-line or configuration arguments.
|
GIT_INFO |
Indicator for Git-related configuration or data.
|
GIT_REPOSITORY |
Key for Git repository information.
|
GIT_COMMIT |
Key to identify a specific Git commit.
|
GIT_AUTHOR |
Key referring to Git author-related details.
|
GIT_AUTHOR_NAME |
Key for the Git author's name.
|
GIT_AUTHOR_EMAIL |
Key for the Git author's email address.
|
GIT_COMMIT_MSG |
Key referencing the Git commit message.
|
GITHUB_INFO |
Key grouping GitHub-related information.
|
GITHUB_PULL_REQUEST |
Key referencing GitHub pull request details.
|
PR_TITLE |
Key representing the pull request title.
|
PR_BODY |
Key referencing the body content of a pull request.
|
PR_IS_DRAFT |
Boolean key indicating if the pull request is a draft.
|
PR_LABELS |
Key for labels assigned to a pull request.
|
CONFIG_PATH |
Configuration file path for a specific setup.
|
INCLUDE_TEMPLATE_CONFIG |
Key specifying inclusion of template config.
|
BASE_FILE_PATH |
Key for referring to a base file path.
|
BASE_URL |
Key representing a base URL in configurations.
|
DIVIDE_API |
Key to segregate divided API-related settings.
|
DIVIDE_HTTP |
Key for separate HTTP-related configurations.
|
DIVIDE_HTTP_REQUEST |
Key for individual HTTP request settings or data.
|
DIVIDE_HTTP_RESPONSE |
Key indicating HTTP response details or mapping.
|
DRY_RUN |
Key to trigger dry run mode for operations.
|
ACCEPT_CONFIG_NOT_EXIST |
Key allowing acceptance of missing configurations.
|
EnvironmentVariableKey
¶
Bases: Enum
Represents an enumeration of environment variable keys.
This class defines a set of keys used for accessing specific environment variables required by the application. Each key represents a constant string value that corresponds to a particular environment configuration.
| ATTRIBUTE | DESCRIPTION |
|---|---|
SURVEILLANCE_CONFIG_PATH |
Key representing the configuration path environment variable.
|