address pr comments

juspay · Dec 20, 2024 · e7db9e0 · e7db9e0
1 parent 6c7414f
commit e7db9e0
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 20 deletions.
diff --git a/api-reference/openapi_spec.json b/api-reference/openapi_spec.json
@@ -958,6 +958,26 @@
         "summary": "Relay - Create",
         "description": "Creates a relay request.",
         "operationId": "Relay Request",
+        "parameters": [
+          {
+            "name": "X-Profile-Id",
+            "in": "header",
+            "description": "Profile ID for authentication",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "X-Idempotency-Key",
+            "in": "header",
+            "description": "Idempotency Key for relay request",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
         "requestBody": {
           "content": {
             "application/json": {
@@ -1014,9 +1034,9 @@
         "operationId": "Retrieve a Relay details",
         "parameters": [
           {
-            "name": "id",
-            "in": "path",
-            "description": "The unique identifier for the Relay",
+            "name": "X-Profile-Id",
+            "in": "header",
+            "description": "Profile ID for authentication",
             "required": true,
             "schema": {
               "type": "string"
@@ -23048,7 +23068,6 @@
         "required": [
           "connector_resource_id",
           "connector_id",
-          "profile_id",
           "type"
         ],
         "properties": {
@@ -23062,11 +23081,6 @@
             "description": "Identifier of the connector ( merchant connector account ) to which relay request is being made",
             "example": "mca_5apGeP94tMts6rg3U3kR"
           },
-          "profile_id": {
-            "type": "string",
-            "description": "The business profile that is associated with this relay request",
-            "example": "pro_abcdefghijklmnopqrstuvwxyz"
-          },
           "type": {
             "$ref": "#/components/schemas/RelayType"
           },

diff --git a/crates/api_models/src/relay.rs b/crates/api_models/src/relay.rs
@@ -12,9 +12,6 @@ pub struct RelayRequest {
     /// Identifier of the connector ( merchant connector account ) to which relay request is being made
     #[schema(example = "mca_5apGeP94tMts6rg3U3kR", value_type = String)]
     pub connector_id: common_utils::id_type::MerchantConnectorAccountId,
-    /// The business profile that is associated with this relay request
-    #[schema(example = "pro_abcdefghijklmnopqrstuvwxyz", value_type = String)]
-    pub profile_id: common_utils::id_type::ProfileId,
     /// The type of relay request
     #[serde(rename = "type")]
     pub relay_type: RelayType,

diff --git a/crates/openapi/src/routes/relay.rs b/crates/openapi/src/routes/relay.rs
@@ -4,11 +4,11 @@
 #[utoipa::path(
     post,
     path = "/relay",
-    request_body  (
+    request_body(
         content = RelayRequest,
-        examples  ((
-                "Create a relay request" = (
-                    value = json!({
+        examples((
+            "Create a relay request" = (
+                value = json!({
                     "connector_resource_id": "7256228702616471803954",
                     "connector_id": "mca_5apGeP94tMts6rg3U3kR",
                     "profile_id": "pro_abcdefghijklmnopqrstuvwxyz",
@@ -17,14 +17,17 @@
                         "amount": 6540,
                         "currency": "USD"
                     }
-                    })
-                )
-            ))
+                })
+            )
+        ))
     ),
     responses(
         (status = 200, description = "Relay request", body = RelayResponse),
         (status = 400, description = "Invalid data")
-
+    ),
+    params(
+        ("X-Profile-Id" = String, Header, description = "Profile ID for authentication"),
+        ("X-Idempotency-Key" = String, Header, description = "Idempotency Key for relay request")
     ),
     tag = "Relay",
     operation_id = "Relay Request",
@@ -44,6 +47,9 @@ pub async fn relay() {}
         (status = 200, description = "Relay Retrieved", body = RelayResponse),
         (status = 404, description = "Relay details was not found")
     ),
+    params(
+        ("X-Profile-Id" = String, Header, description = "Profile ID for authentication")
+    ),
     tag = "Relay",
     operation_id = "Retrieve a Relay details",
     security(("api_key" = []), ("ephemeral_key" = []))