Documentation

    
{
    "$defs": {
        "SAMSecretMetadata": {
            "description": "Smarter API Secret Manifest - Metadata class.",
            "properties": {
                "name": {
                    "description": "Secret.metadata.name[str]. Required. The name of the secret. camelCase, no spaces, no special characters.",
                    "title": "Name",
                    "type": "string"
                },
                "description": {
                    "description": "The description for this resource. Be brief. Keep it under 255 characters.",
                    "title": "Description",
                    "type": "string"
                },
                "version": {
                    "description": "The semantic version of the manifest. Example: 0.1.0",
                    "title": "Version",
                    "type": "string"
                },
                "tags": {
                    "anyOf": [
                        {
                            "items": {
                                "type": "string"
                            },
                            "type": "array"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "default": null,
                    "description": "The tags of the manifest. These are fully functional but are not currently used. Example: [tag1, tag2]",
                    "title": "Tags"
                },
                "annotations": {
                    "anyOf": [
                        {
                            "items": {
                                "type": "string"
                            },
                            "type": "array"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "default": null,
                    "description": "The manifest annotations. These are fully functional but are not currently used.",
                    "title": "Annotations"
                }
            },
            "required": [
                "name",
                "description",
                "version"
            ],
            "title": "SAMSecretMetadata",
            "type": "object"
        },
        "SAMSecretSpec": {
            "description": "Smarter API Secret Manifest Secret.spec",
            "properties": {
                "config": {
                    "$ref": "#/$defs/SAMSecretSpecConfig",
                    "description": "Secret.spec.config[object]. The configuration for the Secret."
                }
            },
            "required": [
                "config"
            ],
            "title": "SAMSecretSpec",
            "type": "object"
        },
        "SAMSecretSpecConfig": {
            "description": "Smarter API Secret Manifest Secret.spec.config",
            "properties": {
                "value": {
                    "description": "Secret.spec.configuration.value[str]. Required. The unencrypted value of the Secret.",
                    "title": "Value",
                    "type": "string"
                },
                "expirationDate": {
                    "anyOf": [
                        {
                            "format": "date",
                            "type": "string"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "default": null,
                    "description": "Secret.spec.configuration.expirationDate[str]. Optional. The expiration date of the Secret.",
                    "title": "Expirationdate"
                }
            },
            "required": [
                "value"
            ],
            "title": "SAMSecretSpecConfig",
            "type": "object"
        },
        "SAMSecretStatus": {
            "description": "Smarter API Secret Manifest - Status class.",
            "properties": {
                "accountNumber": {
                    "default": null,
                    "description": "Secret.status.account_number: The account owner of this Secret. Read only.",
                    "title": "Accountnumber",
                    "type": "string"
                },
                "username": {
                    "default": null,
                    "description": "Secret.status.account_number: The Smarter user who created this Secret. Read only.",
                    "title": "Username",
                    "type": "string"
                },
                "created": {
                    "default": null,
                    "description": "Secret.status.created: The date in which this Secret was created. Read only.",
                    "format": "date-time",
                    "title": "Created",
                    "type": "string"
                },
                "modified": {
                    "default": null,
                    "description": "Secret.status.modified: The date in which this Secret was most recently changed. Read only.",
                    "format": "date-time",
                    "title": "Modified",
                    "type": "string"
                },
                "lastAccessed": {
                    "default": null,
                    "description": "Secret.status.last_accessed: The date in which this Secret was most recently accessed. Read only.",
                    "format": "date-time",
                    "title": "Lastaccessed",
                    "type": "string"
                }
            },
            "title": "SAMSecretStatus",
            "type": "object"
        }
    },
    "description": "Smarter API Manifest - Secret",
    "properties": {
        "apiVersion": {
            "description": "apiVersion[String]: Required. The API version of the AbstractSAMBase.",
            "title": "Apiversion",
            "type": "string"
        },
        "kind": {
            "description": "kind[String]: Required. The kind of resource described by the manifest.",
            "title": "Kind",
            "type": "string"
        },
        "metadata": {
            "$ref": "#/$defs/SAMSecretMetadata",
            "description": "Secret.metadata[obj]: Required, the Secret metadata."
        },
        "spec": {
            "$ref": "#/$defs/SAMSecretSpec",
            "description": "Secret.spec[obj]: Required, the Secret specification."
        },
        "status": {
            "anyOf": [
                {
                    "$ref": "#/$defs/SAMSecretStatus"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
            "description": "Secret.status[obj]: Optional, Read-only. Stateful status information about the Secret."
        }
    },
    "required": [
        "apiVersion",
        "kind",
        "metadata",
        "spec"
    ],
    "title": "SAMSecret",
    "type": "object"
}