docs: Document RequestingApplication struct

Author: iinuwa

CHANGELOG.md

@@ -1,5 +1,11 @@
 # [unreleased]
 
+## Breaking Changes
+
+### UI Controller API
+
+- Reordered parameters in RequestingApplication, and made app name optional.
+
 # [0.2.0] - 2025-02-18
 
 ## Breaking Changes

credentialsd-common/src/model.rs

@@ -96,10 +96,17 @@ impl Transport {
     }
 }
 
+/// Details about the calling application to be displayed in the UI.
 #[derive(Debug, Default, Clone, Serialize, Deserialize, Type)]
 pub struct RequestingApplication {
+    /// The App ID (if called on the portal interface) or path (if called on the
+    /// internal interface).
     pub path_or_app_id: String,
+
+    /// The name of the application.
     pub name: Optional<String>,
+
+    /// The PID of the applicatoin
     pub pid: u32,
 }
 

doc/api.md

@@ -881,6 +881,9 @@ This method should be called when a new credential request begins.
 ViewRequest: [a{sv}] {
     id: u,
     operation: Operation,
+    rp_id: s,
+    requesting_app: RequestingApplication,
+    window_handle: s, // Optional
 }
 ```
 
@@ -891,6 +894,15 @@ Operation[s] [
 ]
 ```
 
+```
+RequestingApplication {
+    name: s, // Optional
+    path_or_app_id: s,
+    pid: u32,
+
+}
+```
+
 ### Response
 
 None.