fix: change url to uri (#104)

* fix: change `url` to `uri` * chore: update changelog
impierce · Aug 7, 2024 · 47f4f82 · 47f4f82
1 parent 560a20f
commit 47f4f82
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,22 @@
+### 07-08-2024
+- Renamed the display `url` property in the `credential_configurations` in the Configuration to `uri`, e.g.:
+```yaml
+# agent_application/config.yaml
+credential_configurations:
+  - credential_configuration_id: w3c_vc_credential
+    format: jwt_vc_json
+    credential_definition:
+      type:
+        - VerifiableCredential
+    display:
+      - name: Verifiable Credential
+        locale: en
+        logo:
+          # The property below has been renamed from `url` to `uri`
+          uri: https://www.impierce.com/external/impierce-logo.png
+          alt_text: UniCore Logo
+```
+
 ### 29-07-2024
 - Renamed env variable prefix from `AGENT` to `UNICORE`.
 - Refactored the environment variables separators from `_` to `__` to support nested configuration values. As an example, `AGENT_LOG_FORMAT` now becomes `UNICORE__LOG_FORMAT`.

diff --git a/agent_api_rest/src/issuance/credential_issuer/well_known/openid_credential_issuer.rs b/agent_api_rest/src/issuance/credential_issuer/well_known/openid_credential_issuer.rs
@@ -108,7 +108,7 @@ mod tests {
                             "name": "Verifiable Credential",
                             "locale": "en",
                             "logo": {
-                                "url": "https://impierce.com/images/logo-blue.png",
+                                "uri": "https://impierce.com/images/logo-blue.png",
                                 "alt_text": "UniCore Logo"
                             }
                         })],
@@ -120,7 +120,7 @@ mod tests {
                     "name": "UniCore",
                     "locale": "en",
                     "logo": {
-                        "url": "https://impierce.com/images/favicon/apple-touch-icon.png",
+                        "uri": "https://impierce.com/images/favicon/apple-touch-icon.png",
                         "alt_text": "UniCore Logo"
                     }
                 })]),

diff --git a/agent_application/example.config.yaml b/agent_application/example.config.yaml
@@ -65,7 +65,7 @@ credential_configurations:
       - name: Verifiable Credential
         locale: en
         logo:
-          url: https://www.impierce.com/external/impierce-logo.png
+          uri: https://www.impierce.com/external/impierce-logo.png
           alt_text: UniCore Logo
 
 # Key configuration (temporary)

diff --git a/agent_shared/src/config.rs b/agent_shared/src/config.rs
@@ -81,9 +81,7 @@ pub struct CredentialConfiguration {
 #[skip_serializing_none]
 #[derive(Serialize, Deserialize, Debug, Clone)]
 pub struct Logo {
-    // TODO: remove this alias and change field to `uri`.
-    #[serde(alias = "uri")]
-    pub url: Option<Url>,
+    pub uri: Option<Url>,
     pub alt_text: Option<String>,
 }
 

diff --git a/agent_shared/tests/test-config.yaml b/agent_shared/tests/test-config.yaml
@@ -53,7 +53,7 @@ credential_configurations:
       - name: Verifiable Credential
         locale: en
         logo:
-          url: https://impierce.com/images/logo-blue.png
+          uri: https://impierce.com/images/logo-blue.png
           alt_text: UniCore Logo
 
 secret_manager:

diff --git a/agent_verification/src/services.rs b/agent_verification/src/services.rs
@@ -21,7 +21,7 @@ impl VerificationServices {
         let logo_uri = config()
             .display
             .first()
-            .and_then(|display| display.logo.as_ref().and_then(|logo| logo.url.clone()));
+            .and_then(|display| display.logo.as_ref().and_then(|logo| logo.uri.clone()));
 
         let signing_algorithms_supported: Vec<Algorithm> = config()
             .signing_algorithms_supported