fix: secret keys cannot contain underscores

Renaming role_id to role-id and role_secret_id to role-secret-id
canonical · Aug 25, 2023 · 780a0a9 · 780a0a9
1 parent b41853e
commit 780a0a9
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/docs/json_schemas/vault_kv/v0/provider.json b/docs/json_schemas/vault_kv/v0/provider.json
@@ -35,7 +35,7 @@
         },
         "credentials": {
           "title": "Credentials",
-          "description": "Mapping of unit name and credentials for that unit. Credentials are a juju secret containing a role_id and role_secret_id.",
+          "description": "Mapping of unit name and credentials for that unit. Credentials are a juju secret containing a role-id and role-secret-id.",
           "type": "object",
           "additionalProperties": {
             "type": "string"

diff --git a/interfaces/vault_kv/v0/README.md b/interfaces/vault_kv/v0/README.md
@@ -22,9 +22,9 @@ Provider expectations
 
 - Must provide the vault url
 - Must provide a key value mount, the mount name shall respect the following pattern: charm-<requirer app>-<user provided suffix>
-- Must provide a role_id and role_secret_id for each unit.
-  The role_id and role_secret_id shall be provided in the form of a Juju secret.
-  Usage of role_id and role_secret_id to access the KV backend shall be restricted to the unit's egress_subnet.
+- Must provide a role-id and role-secret-id for each unit.
+  The role-id and role-secret-id shall be provided in the form of a Juju secret.
+  Usage of role-id and role-secret-id to access the KV backend shall be restricted to the unit's egress_subnet.
 
 ### Requirer
 

diff --git a/interfaces/vault_kv/v0/schema.py b/interfaces/vault_kv/v0/schema.py
@@ -23,7 +23,7 @@ class VaultKvProviderSchema(BaseModel):
     credentials: Json[Mapping[str, str]] = Field(
         description=(
             "Mapping of unit name and credentials for that unit."
-            " Credentials are a juju secret containing a role_id and role_secret_id."
+            " Credentials are a juju secret containing a role-id and role-secret-id."
         )
     )