SAMSecret

SAM model of the Secret kind, generated from the Smarter platform’s JSON Schema.

Do not edit: run scripts/generate_sam_models.py. See smarter.models.sam.

class smarter.models.sam.secret.SAMDependency(*, kind: str, name: str, **extra_data: Any)

Bases: SAMModel

A resource that depends on the resource that a manifest describes.

kind: str

Kind[String]: The SAM kind of the resource that depends on this resource, e.g. LLMClient.

Read only.

name: str

Name[String]: The name of the resource that depends on this resource.

Read only.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

class smarter.models.sam.secret.SAMSecretMetadata(*, annotations: None | list[dict[str, str | int | float | bool | date | datetime | UUID | bytes | list | dict[str, Any]]] = None, description: str | None, name: str, tags: list[str] | None = None, version: str | None, **extra_data: Any)

Bases: SAMModel

Smarter API Secret Manifest - Metadata class.

annotations: None | list[dict[str, str | int | float | bool | date | datetime | UUID | bytes | list | dict[str, Any]]]

The manifest annotations.

Used for storing arbitrary metadata as

key-value pairs. Example: [{‘smarter.sh/test-manifest/project-name’: ‘Scooby dooby do’}]. The key should be a valid url-friendly string. The value accepts multi-line string values (YAML block scalars) and various scalar types including str, int, float, bool, datetime.date, datetime.datetime, decimal.Decimal, uuid.UUID, bytes, list, dict.

description: str | None

The description for this resource.

Be brief. Keep it under 255 characters.

name: str

Secret.metadata.name[str].

Required. The name of the secret. camelCase, no spaces, no special characters.

tags: list[str] | None

The tags of the manifest.

Used for generic resource categorization and search. Example: [‘tag1’, ‘tag2’]

version: str | None

The semantic version of the manifest.

Example: 0.1.0

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

class smarter.models.sam.secret.SAMSecretSpecConfig(*, expiration_date: datetime | None = None, value: str, **extra_data: Any)

Bases: SAMModel

Smarter API Secret Manifest Secret.spec.config.

expiration_date: datetime | None

Secret.spec.configuration.expiration_date[str].

Optional. The expiration date of the Secret.

value: str

Secret.spec.configuration.value[str].

Required. The unencrypted value of the Secret.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

class smarter.models.sam.secret.SAMSecretStatus(*, accountNumber: str, created: datetime, dependencies: list[SAMDependency] | None = None, last_accessed: datetime | None = None, modified: datetime, recordLocator: str, username: str, **extra_data: Any)

Bases: SAMModel

Smarter API Secret Manifest - Status class (read-only, like Kubernetes status attributes).

accountNumber: str

Secret.status.account_number: The account owner of this Secret.

Read only.

created: datetime

The date in which this resource was created.

Read only.

dependencies: list[SAMDependency] | None

Dependencies[List]: The resources that depend on this resource, and that must be deleted, or stop referring to it, before it can be deleted.

Lists only the resources that you can read. Read only.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

last_accessed: datetime | None

Secret.status.last_accessed: The date in which this Secret was most recently accessed.

Read only.

modified: datetime

The date in which this resource was most recently changed.

Read only.

recordLocator: str

RecordLocator[String]: An optional identifier used to locate the resource record associated with this manifest.

Read only.

username: str

Secret.status.account_number: The Smarter user who created this Secret.

Read only.

class smarter.models.sam.secret.SAMSecretSpec(*, config: SAMSecretSpecConfig, **extra_data: Any)

Bases: SAMModel

Smarter API Secret Manifest Secret.spec.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

config: SAMSecretSpecConfig

Secret.spec.config[object].

The configuration for the Secret.

class smarter.models.sam.secret.SAMSecret(*, apiVersion: str, kind: str, metadata: SAMSecretMetadata, spec: SAMSecretSpec, status: SAMSecretStatus | None = None, **extra_data: Any)

Bases: SAMModel

Smarter API Manifest - Secret.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

apiVersion: str

ApiVersion[String]: Required.

The API version of the AbstractSAMBase.

kind: str

Kind[String]: Required.

The kind of resource described by the manifest.

metadata: SAMSecretMetadata

Secret.metadata[obj]: Required, the Secret metadata.

spec: SAMSecretSpec

Secret.spec[obj]: Required, the Secret specification.

status: SAMSecretStatus | None

Secret.status[obj]: Optional, Read-only.

Stateful status information about the Secret.