Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(openapi): Standardise API naming scheme for V2 #6510

Merged
merged 11 commits into from
Nov 29, 2024
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
openapi: post /v2/api_keys
openapi: post /v2/api-keys
---
2 changes: 1 addition & 1 deletion api-reference-v2/api-reference/api-key/api-key--list.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
openapi: get /v2/api_keys/list
openapi: get /v2/api-keys/list
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
openapi: get /v2/api_keys/{id}
openapi: get /v2/api-keys/{id}
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
openapi: delete /v2/api_keys/{id}
openapi: delete /v2/api-keys/{id}
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
openapi: put /v2/api_keys/{id}
openapi: put /v2/api-keys/{id}
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
openapi: get /v2/profiles/{profile_id}/connector_accounts
openapi: get /v2/profiles/{profile_id}/connector-accounts
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
openapi: post /v2/connector_accounts
openapi: post /v2/connector-accounts
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
openapi: delete /v2/connector_accounts/{id}
openapi: delete /v2/connector-accounts/{id}
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
openapi: get /v2/connector_accounts/{id}
openapi: get /v2/connector-accounts/{id}
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
openapi: put /v2/connector_accounts/{id}
openapi: put /v2/connector-accounts/{id}
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
openapi: get /v2/merchant_accounts/{id}/profiles
openapi: get /v2/merchant-accounts/{id}/profiles
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
openapi: post /v2/merchant_accounts
openapi: post /v2/merchant-accounts
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
openapi: get /v2/merchant_accounts/{id}
openapi: get /v2/merchant-accounts/{id}
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
openapi: put /v2/merchant_accounts/{id}
openapi: put /v2/merchant-accounts/{id}
---

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
openapi: get /v2/organization/{id}/merchant_accounts
openapi: get /v2/organization/{id}/merchant-accounts
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v2/payments/{id}/saved-payment-methods
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v2/customers/{id}/saved-payment-methods
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /v2/payment-methods/{id}/confirm-intent
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /v2/payment-methods/create-intent
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /v2/payment-methods
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /v2/payment-methods/{id}
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /v2/payment-methods/{id}
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: patch /v2/payment-methods/{id}/update-saved-payment-method
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
openapi: get /v2/profiles/{id}/connector_accounts
openapi: get /v2/profiles/{id}/connector-accounts
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
openapi: patch /v2/profiles/{id}/activate_routing_algorithm
openapi: patch /v2/profiles/{id}/activate-routing-algorithm
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
openapi: patch /v2/profiles/{id}/deactivate_routing_algorithm
openapi: patch /v2/profiles/{id}/deactivate-routing-algorithm
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
openapi: get /v2/profiles/{id}/routing_algorithm
openapi: get /v2/profiles/{id}/routing-algorithm
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
openapi: get /v2/profiles/{id}/fallback_routing
openapi: get /v2/profiles/{id}/fallback-routing
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
openapi: patch /v2/profiles/{id}/fallback_routing
openapi: patch /v2/profiles/{id}/fallback-routing
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
openapi: post /v2/routing_algorithm
openapi: post /v2/routing-algorithm
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
openapi: get /v2/routing_algorithm/{id}
openapi: get /v2/routing-algorithm/{id}
---
23 changes: 20 additions & 3 deletions api-reference-v2/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@
"navigation": [
{
"group": "Get Started",
"pages": ["introduction"]
"pages": [
"introduction"
]
},
{
"group": "Essentials",
Expand All @@ -43,6 +45,19 @@
"api-reference/payments/payments--get"
]
},
{
"group": "Payment Methods",
"pages": [
"api-reference/payment-methods/payment-method--create",
"api-reference/payment-methods/payment-method--retrieve",
"api-reference/payment-methods/payment-method--update",
"api-reference/payment-methods/payment-method--delete",
"api-reference/payment-methods/payment-method--create-intent",
"api-reference/payment-methods/payment-method--confirm-intent",
"api-reference/payment-methods/list-customer-saved-payment-methods-for-a-payment",
"api-reference/payment-methods/list-payment-methods-for-a-customer"
]
},
{
"group": "Organization",
"pages": [
Expand Down Expand Up @@ -119,8 +134,10 @@
"github": "https://github.com/juspay/hyperswitch",
"linkedin": "https://www.linkedin.com/company/hyperswitch"
},
"openapi": ["openapi_spec.json"],
"openapi": [
"openapi_spec.json"
],
"api": {
"maintainOrder": true
}
}
}
Loading
Loading