ConfigSecretPut common.config-secret-put@1
Generated at from
openvibe-contracts v0.419.0 and
openvibe-sdk v0.161.0.
- Version
- 1.0.0
- Owner
- network
- Visibility
- internal
- Status
- active
- Compatibility
- backward
- Schema
https://openvibe.network/contracts/common/config-secret-put.v1.json
common.config-secret-put@1 (AI Exchange D11): body of PUT /internal/config/:namespace/secrets/:key on a service's openvibe-shared/config admin routes. The value is written once, sealed as an envelope under the service's KEK (or kept as today when it has none), and never returned, logged or put in values_json. Its answer is the marker: { redacted: true, fingerprint, hint (four characters), set_at, set_by, bound_to }, as common.config-namespace@1 defines it. A `x-bind` key on the namespace schema binds the secret to another key's value (a provider key to its base_url origin); a changed bind no longer opens the value until the owner enters it again.
Fields
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
value | string | yes | The secret, once. |
|
reason | string | yes | Why the secret is set; it is the revision's reason in the history. |
|
Examples
From the contract's own test fixtures: valid ones validate, rejected ones must fail.
Valid: put
{
"value": "AIza-example-secret",
"reason": "Set the YouTube API key"
}Rejected: empty-value
{
"value": "",
"reason": "Set the YouTube API key"
}Rejected: missing-reason
{
"value": "AIza-example-secret"
}Validate
const contracts = require('openvibe-contracts');
contracts.validate('common.config-secret-put@1', value); // { valid, errors: [{ path, message }] }