Skip to main content

Module constants

Module constants 

Source
Expand description

Centralized string constants for the Aperture CLI

This module contains commonly used string literals to:

  • Reduce string duplication
  • Improve maintainability
  • Ensure consistency across the codebase

Constants§

AUTH_SCHEME_APIKEY
AUTH_SCHEME_BASIC
AUTH_SCHEME_BEARER
AUTH_SCHEME_OAUTH2
AUTH_SCHEME_OPENID
CACHE_FILE_SUFFIX
CACHE_METADATA_FILENAME
CACHE_SUFFIX
CLI_ROOT_COMMAND
COMPONENT_CALLBACKS
COMPONENT_COMPONENTS
COMPONENT_EXAMPLES
COMPONENT_HEADERS
COMPONENT_LINKS
COMPONENT_PARAMETERS
COMPONENT_REQUEST_BODIES
COMPONENT_RESPONSES
COMPONENT_SCHEMAS
COMPONENT_SECURITY_SCHEMES
CONFIG_FILENAME
CONTENT_TYPE_CSV
CONTENT_TYPE_FORM
CONTENT_TYPE_GRAPHQL
CONTENT_TYPE_IDENTIFIER_JSON
CONTENT_TYPE_IDENTIFIER_TEXT
CONTENT_TYPE_IDENTIFIER_YAML
CONTENT_TYPE_JSON
CONTENT_TYPE_MULTIPART
CONTENT_TYPE_NDJSON
CONTENT_TYPE_OCTET_STREAM
CONTENT_TYPE_PDF
CONTENT_TYPE_PREFIX_IMAGE
CONTENT_TYPE_TEXT
CONTENT_TYPE_TEXT_XML
CONTENT_TYPE_XML
CONTENT_TYPE_YAML
CONTEXT_BATCH
DEFAULT_CACHE_TTL
DEFAULT_GROUP
DEFAULT_OPERATION_NAME
DIR_CACHE
DIR_RESPONSES
DIR_SPECS
EMPTY_ARRAY
EMPTY_RESPONSE
ENV_APERTURE_BASE_URL
ENV_APERTURE_CONFIG_DIR
ENV_APERTURE_ENV
ERR_API_CREDENTIALS
ERR_CONNECTION
ERR_ENDPOINT_NOT_FOUND
ERR_FILE_NOT_FOUND
ERR_JSON_SYNTAX
ERR_OPENAPI_FORMAT
ERR_PERMISSION
ERR_PERMISSION_DENIED
ERR_RATE_LIMITED
ERR_SERVER_ERROR
ERR_TIMEOUT
ERR_TOML_SYNTAX
ERR_YAML_SYNTAX
EXT_APERTURE_SECRET
EXT_KEY_NAME
EXT_KEY_SOURCE
FIELD_ALLOW_EMPTY_VALUE
FIELD_ALLOW_RESERVED
FIELD_DEPRECATED
FIELD_EXCLUSIVE_MAXIMUM
FIELD_EXCLUSIVE_MINIMUM
FIELD_EXPLODE
FIELD_NULLABLE
FIELD_READ_ONLY
FIELD_REQUIRED
FIELD_UNIQUE_ITEMS
FIELD_WRITE_ONLY
FILE_EXT_BIN
FILE_EXT_JSON
FILE_EXT_YAML
HEADER_ACCEPT
HEADER_API_KEY
HEADER_AUTHORIZATION
HEADER_AUTHORIZATION_LC
HEADER_BEARER
HEADER_CONTENT_TYPE
HEADER_CONTENT_TYPE_LC
HEADER_COOKIE
HEADER_PREFIX_X_API
HEADER_PREFIX_X_AUTH
HEADER_PROXY_AUTHORIZATION
HEADER_TOKEN
HEADER_X_API_KEY
HEADER_X_API_TOKEN
HEADER_X_AUTH_TOKEN
HTTP_METHOD_DELETE
HTTP_METHOD_GET
HTTP_METHOD_HEAD
HTTP_METHOD_OPTIONS
HTTP_METHOD_PATCH
HTTP_METHOD_POST
HTTP_METHOD_PUT
LOCATION_HEADER
MSG_USE_CONFIG_LIST
MSG_USE_HELP
MSG_WARNING_PREFIX
NULL_VALUE
PARAM_LOCATION_COOKIE
PARAM_LOCATION_HEADER
PARAM_LOCATION_PATH
PARAM_LOCATION_QUERY
SCHEMA_TYPE_ARRAY
SCHEMA_TYPE_BOOLEAN
SCHEMA_TYPE_INTEGER
SCHEMA_TYPE_NUMBER
SCHEMA_TYPE_OBJECT
SCHEMA_TYPE_STRING
SECURITY_TYPE_APIKEY
SECURITY_TYPE_HTTP
SOURCE_ENV
SUCCESS_STATUS_CODES

Functions§

is_auth_header
Check if a header name is authentication-related
is_json_content_type
Check if a content type is JSON
is_supported_content_type
Check if a content type is supported for request/response bodies