PISHPS-282: renamed directory, refactored credit-card openapi v3 docu…

…mentation (#765) * PISHPS-282: added openapi v3 documentation for store-api and admin-api * PISHPS-282: removed /api/ and /store-api from routes, documented credit-card endpoints and renamed directory * PISHPS-282: removed duplicated openapi v3 json files
mollie · Jun 25, 2024 · 68dc57e · 68dc57e
1 parent 286b1bb
commit 68dc57e
Show file tree

Hide file tree

Showing 43 changed files with 321 additions and 371 deletions.
diff --git a/...ema/admin-api/create-support-request.json → ...hema/AdminApi/create-support-request.json b/...ema/admin-api/create-support-request.json → ...hema/AdminApi/create-support-request.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/api/_action/mollie/support/request": {
+    "/_action/mollie/support/request": {
       "post": {
         "summary": "Submit Support Request to Mollie",
         "description": "Submits a support request to Mollie.",

diff --git a/...s/Schema/admin-api/order-payment-url.json → ...es/Schema/AdminApi/order-payment-url.json b/...s/Schema/admin-api/order-payment-url.json → ...es/Schema/AdminApi/order-payment-url.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/api/_action/mollie/order/payment-url": {
+    "/_action/mollie/order/payment-url": {
       "post": {
         "summary": "Generate Mollie Order Payment URL",
         "description": "Creates a payment URL for a Mollie order.",

diff --git a/...hema/admin-api/payment-method-update.json → ...chema/AdminApi/payment-method-update.json b/...hema/admin-api/payment-method-update.json → ...chema/AdminApi/payment-method-update.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/api/_action/mollie/payment-method/update-methods": {
+    "/_action/mollie/payment-method/update-methods": {
       "get": {
         "summary": "Update Mollie Payment Methods",
         "description": "Updates the payment methods for Mollie.",

diff --git a/...sources/Schema/admin-api/refund-list.json → ...esources/Schema/AdminApi/refund-list.json b/...sources/Schema/admin-api/refund-list.json → ...esources/Schema/AdminApi/refund-list.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/api/_action/mollie/refund/list": {
+    "/_action/mollie/refund/list": {
       "post": {
         "summary": "List Refund Items for Mollie Order",
         "description": "Retrieves a list of refund items for a Mollie order.",

diff --git a/...Schema/admin-api/refund-manager-data.json → .../Schema/AdminApi/refund-manager-data.json b/...Schema/admin-api/refund-manager-data.json → .../Schema/AdminApi/refund-manager-data.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/api/_action/mollie/refund-manager/data": {
+    "/_action/mollie/refund-manager/data": {
       "post": {
         "summary": "Get Refund Manager Data",
         "description": "Retrieves refund manager data for a Mollie order.",

diff --git a/...es/Schema/admin-api/refund-order-get.json → ...ces/Schema/AdminApi/refund-order-get.json b/...es/Schema/admin-api/refund-order-get.json → ...ces/Schema/AdminApi/refund-order-get.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/api/mollie/refund/order": {
+    "/mollie/refund/order": {
       "post": {
         "summary": "Process Refund for Mollie Order",
         "description": "Processes a refund for a Mollie order.",

diff --git a/...s/Schema/admin-api/refund-order-post.json → ...es/Schema/AdminApi/refund-order-post.json b/...s/Schema/admin-api/refund-order-post.json → ...es/Schema/AdminApi/refund-order-post.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/api/_action/mollie/refund": {
+    "/_action/mollie/refund": {
       "post": {
         "summary": "Process Refund for Mollie Order",
         "description": "Processes a refund for a Mollie order.",

diff --git a/...ources/Schema/admin-api/refund-total.json → ...sources/Schema/AdminApi/refund-total.json b/...ources/Schema/admin-api/refund-total.json → ...sources/Schema/AdminApi/refund-total.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/api/_action/mollie/refund/total": {
+    "/_action/mollie/refund/total": {
       "post": {
         "summary": "Get Total Refund Information",
         "description": "Retrieves the total refund information for a Mollie order.",

diff --git a/...ema/admin-api/ship-order-operational.json → ...hema/AdminApi/ship-order-operational.json b/...ema/admin-api/ship-order-operational.json → ...hema/AdminApi/ship-order-operational.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/api/mollie/ship/order": {
+    "/mollie/ship/order": {
       "post": {
         "summary": "Ship Order via Mollie",
         "description": "Ships an order via Mollie with tracking information.",

diff --git a/...ces/Schema/admin-api/shipping-status.json → ...rces/Schema/AdminApi/shipping-status.json b/...ces/Schema/admin-api/shipping-status.json → ...rces/Schema/AdminApi/shipping-status.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/api/_action/mollie/ship/status": {
+    "/_action/mollie/ship/status": {
       "post": {
         "summary": "Retrieve Mollie Order Shipping Status",
         "description": "Retrieves the shipping status for a Mollie order.",

diff --git a/...rces/Schema/admin-api/shipping-total.json → ...urces/Schema/AdminApi/shipping-total.json b/...rces/Schema/admin-api/shipping-total.json → ...urces/Schema/AdminApi/shipping-total.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/api/_action/mollie/ship/total": {
+    "/_action/mollie/ship/total": {
       "post": {
         "summary": "Retrieve Total Shipping Information",
         "description": "Retrieves the total shipping information for a Mollie order.",

diff --git a/...Schema/admin-api/subscription-cancel.json → .../Schema/AdminApi/subscription-cancel.json b/...Schema/admin-api/subscription-cancel.json → .../Schema/AdminApi/subscription-cancel.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/api/_action/mollie/subscriptions/cancel": {
+    "/_action/mollie/subscriptions/cancel": {
       "post": {
         "summary": "Cancel Mollie Subscription",
         "description": "Cancels a subscription in Mollie.",

diff --git a/.../Schema/admin-api/subscription-pause.json → ...s/Schema/AdminApi/subscription-pause.json b/.../Schema/admin-api/subscription-pause.json → ...s/Schema/AdminApi/subscription-pause.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/api/_action/mollie/subscriptions/pause": {
+    "/_action/mollie/subscriptions/pause": {
       "post": {
         "summary": "Pause Mollie Subscription",
         "description": "Pauses a subscription in Mollie.",

diff --git a/...Schema/admin-api/subscription-resume.json → .../Schema/AdminApi/subscription-resume.json b/...Schema/admin-api/subscription-resume.json → .../Schema/AdminApi/subscription-resume.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/api/_action/mollie/subscriptions/resume": {
+    "/_action/mollie/subscriptions/resume": {
       "post": {
         "summary": "Resume Mollie Subscription",
         "description": "Resumes a paused subscription in Mollie.",

diff --git a/...s/Schema/admin-api/subscription-skip.json → ...es/Schema/AdminApi/subscription-skip.json b/...s/Schema/admin-api/subscription-skip.json → ...es/Schema/AdminApi/subscription-skip.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/api/_action/mollie/subscriptions/skip": {
+    "/_action/mollie/subscriptions/skip": {
       "post": {
         "summary": "Skip Mollie Subscription",
         "description": "Skips the next scheduled payment for a subscription in Mollie.",

diff --git a/...ema/admin-api/webhook-mandate-update.json → ...hema/AdminApi/webhook-mandate-update.json b/...ema/admin-api/webhook-mandate-update.json → ...hema/AdminApi/webhook-mandate-update.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/api/mollie/webhook/subscription/{swSubscriptionId}/mandate/update": {
+    "/mollie/webhook/subscription/{swSubscriptionId}/mandate/update": {
       "get": {
         "summary": "Handle Mollie Subscription Mandate Update Webhook Notification (GET)",
         "operationId": "handleMollieSubscriptionMandateUpdateWebhookGet",

diff --git a/...dmin-api/webhook-subscription-action.json → ...AdminApi/webhook-subscription-action.json b/...dmin-api/webhook-subscription-action.json → ...AdminApi/webhook-subscription-action.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/api/mollie/webhook/subscription/{swSubscriptionId}": {
+    "/mollie/webhook/subscription/{swSubscriptionId}": {
       "get": {
         "summary": "Handle Mollie Subscription Webhook Notification (GET)",
         "operationId": "handleMollieSubscriptionWebhookGet",

diff --git a/...admin-api/webhook-subscription-renew.json → .../AdminApi/webhook-subscription-renew.json b/...admin-api/webhook-subscription-renew.json → .../AdminApi/webhook-subscription-renew.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/api/mollie/webhook/subscription/{swSubscriptionId}/renew": {
+    "/mollie/webhook/subscription/{swSubscriptionId}/renew": {
       "get": {
         "summary": "Handle Mollie Subscription Renewal Webhook Notification (GET)",
         "operationId": "handleMollieSubscriptionRenewalWebhookGet",

diff --git a/...ces/Schema/admin-api/weebhook-action.json → ...rces/Schema/AdminApi/weebhook-action.json b/...ces/Schema/admin-api/weebhook-action.json → ...rces/Schema/AdminApi/weebhook-action.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/api/mollie/webhook/{swTransactionId}": {
+    "/mollie/webhook/{swTransactionId}": {
       "post": {
         "summary": "Handle Mollie Webhook Notification",
         "description": "Handles incoming webhook notifications from Mollie.",

diff --git a/...hema/store-api/apple-pay-add-product.json → ...chema/StoreApi/apple-pay-add-product.json b/...hema/store-api/apple-pay-add-product.json → ...chema/StoreApi/apple-pay-add-product.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/store-api/mollie/applepay/add-product": {
+    "/mollie/applepay/add-product": {
       "post": {
         "summary": "Add Product for Apple Pay",
         "operationId": "addProductForApplePay",

diff --git a/...api/apple-pay-create-payment-session.json → ...Api/apple-pay-create-payment-session.json b/...api/apple-pay-create-payment-session.json → ...Api/apple-pay-create-payment-session.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/store-api/mollie/applepay/validate/createPaymentSession": {
+    "/mollie/applepay/validate/createPaymentSession": {
       "post": {
         "summary": "Validate and Create Apple Pay Payment Session",
         "operationId": "validateAndCreateApplePayPaymentSession",

diff --git a/...s/Schema/store-api/apple-pay-enabled.json → ...es/Schema/StoreApi/apple-pay-enabled.json b/...s/Schema/store-api/apple-pay-enabled.json → ...es/Schema/StoreApi/apple-pay-enabled.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/store-api/mollie/applepay/enabled": {
+    "/mollie/applepay/enabled": {
       "get": {
         "summary": "Check Apple Pay Integration Enabled Status",
         "operationId": "checkApplePayEnabled",

diff --git a/...Schema/store-api/apple-pay-get-by-id.json → .../Schema/StoreApi/apple-pay-get-by-id.json b/...Schema/store-api/apple-pay-get-by-id.json → .../Schema/StoreApi/apple-pay-get-by-id.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/store-api/mollie/applepay/id": {
+    "/mollie/applepay/id": {
       "get": {
         "summary": "Retrieve Apple Pay ID",
         "operationId": "retrieveApplePayId",

diff --git a/...e-api/apple-pay-get-shipping-methods.json → ...reApi/apple-pay-get-shipping-methods.json b/...e-api/apple-pay-get-shipping-methods.json → ...reApi/apple-pay-get-shipping-methods.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/store-api/mollie/applepay/shipping-methods": {
+    "/mollie/applepay/shipping-methods": {
       "post": {
         "summary": "Retrieve Apple Pay Shipping Methods",
         "operationId": "retrieveApplePayShippingMethods",

diff --git a/...urces/Schema/store-api/apple-pay-pay.json → ...ources/Schema/StoreApi/apple-pay-pay.json b/...urces/Schema/store-api/apple-pay-pay.json → ...ources/Schema/StoreApi/apple-pay-pay.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/store-api/mollie/applepay/pay": {
+    "/mollie/applepay/pay": {
       "post": {
         "summary": "Initiate Apple Pay Payment",
         "operationId": "initiateApplePayPayment",

diff --git a/...ema/store-api/apple-pay-restore-cart.json → ...hema/StoreApi/apple-pay-restore-cart.json b/...ema/store-api/apple-pay-restore-cart.json → ...hema/StoreApi/apple-pay-restore-cart.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/store-api/mollie/applepay/restore-cart": {
+    "/mollie/applepay/restore-cart": {
       "post": {
         "summary": "Restore Apple Pay Cart",
         "operationId": "restoreApplePayCart",

diff --git a/...re-api/apple-pay-set-shipping-method.json → ...oreApi/apple-pay-set-shipping-method.json b/...re-api/apple-pay-set-shipping-method.json → ...oreApi/apple-pay-set-shipping-method.json
@@ -6,7 +6,7 @@
     "version": "1.0.0"
   },
   "paths": {
-    "/store-api/mollie/applepay/shipping-method": {
+    "/mollie/applepay/shipping-method": {
       "post": {
         "summary": "Select Apple Pay Shipping Method",
         "operationId": "selectApplePayShippingMethod",

diff --git a/src/Resources/Schema/StoreApi/credit-card-get-mandates.json b/src/Resources/Schema/StoreApi/credit-card-get-mandates.json
@@ -0,0 +1,109 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "Mollie API",
+    "description": "API for Mollie payment integration.",
+    "version": "1.0.0"
+  },
+  "paths": {
+    "/mollie/mandates/{customerId}": {
+      "get": {
+        "summary": "Get Customer Mandates",
+        "description": "Retrieves a list of mandates for the specified customer.",
+        "operationId": "getCustomerMandates",
+        "parameters": [
+          {
+            "name": "customerId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            },
+            "description": "The ID of the customer whose mandates are being retrieved."
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "A list of customer mandates.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/mandate"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "CreditCardDetailStruct": {
+        "type": "object",
+        "properties": {
+          "cardNumber": {
+            "type": "string"
+          },
+          "expiryDate": {
+            "type": "string"
+          }
+        }
+      },
+      "mandate": {
+        "type": "object",
+        "properties": {
+          "resource": {
+            "type": "string",
+            "nullable": true
+          },
+          "id": {
+            "type": "string",
+            "nullable": true
+          },
+          "mode": {
+            "type": "string",
+            "nullable": true
+          },
+          "status": {
+            "type": "string",
+            "nullable": true
+          },
+          "method": {
+            "type": "string",
+            "nullable": true
+          },
+          "details": {
+            "$ref": "#/components/schemas/CreditCardDetailStruct"
+          },
+          "customerId": {
+            "type": "string",
+            "nullable": true
+          },
+          "mandateReference": {
+            "type": "string",
+            "nullable": true
+          },
+          "signatureDate": {
+            "type": "string",
+            "nullable": true
+          },
+          "createdAt": {
+            "type": "string",
+            "nullable": true
+          },
+          "beingUsedForSubscription": {
+            "type": "boolean"
+          }
+        },
+        "required": [
+          "details",
+          "beingUsedForSubscription"
+        ]
+      }
+    }
+  }
+}