rust/hyperswitch
1
0
Fork 0
mirror of https://github.com/juspay/hyperswitch.git synced 2025-11-01 11:06:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: api-reference changes for customers and admin list apis for v2 (#5936)

Browse Source
This commit is contained in:
Sai Harsha Vardhan
2024-09-18 15:58:39 +05:30
committed by GitHub
parent 99f5933894
commit ed13146b80
16 changed files with 51 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
api-reference-v2/api-reference/business-profile/merchant-connector--list.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /v2/profiles/{profile_id}/connector_accounts
---

3
api-reference-v2/api-reference/customers/customers--create.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /v2/customers
---

3
api-reference-v2/api-reference/customers/customers--delete.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: delete /v2/customers/{id}
---

3
api-reference-v2/api-reference/customers/customers--list.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /v2/customers/list
---

3
api-reference-v2/api-reference/customers/customers--retrieve.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /v2/customers/{id}
---

3
api-reference-v2/api-reference/customers/customers--update.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /v2/customers/{id}
---

3
api-reference-v2/api-reference/merchant-account/business-profile--list.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /v2/merchant_accounts/{account_id}/profiles
---

2
api-reference-v2/api-reference/merchant-account/merchant-account--create.mdx
View File

@ -1,3 +1,3 @@
---
openapi: post /v2/accounts
openapi: post /v2/merchant_accounts
---

2
api-reference-v2/api-reference/merchant-account/merchant-account--retrieve.mdx
View File

@ -1,3 +1,3 @@
---
openapi: get /v2/accounts/{id}
openapi: get /v2/merchant_accounts/{id}
---

2
api-reference-v2/api-reference/merchant-account/merchant-account--update.mdx
View File

@ -1,3 +1,3 @@
---
openapi: put /v2/accounts/{id}
openapi: put /v2/merchant_accounts/{id}
---

3
api-reference-v2/api-reference/organization/merchant-account--list.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /v2/organization/{organization_id}/merchant_accounts
---

17
api-reference-v2/mint.json
View File

@ -39,7 +39,8 @@
"pages": [
"api-reference/organization/organization--create",
"api-reference/organization/organization--retrieve",
"api-reference/organization/organization--update"
"api-reference/organization/organization--update",
"api-reference/organization/merchant-account--list"
]
},
{
@ -47,7 +48,8 @@
"pages": [
"api-reference/merchant-account/merchant-account--create",
"api-reference/merchant-account/merchant-account--retrieve",
"api-reference/merchant-account/merchant-account--update"
"api-reference/merchant-account/merchant-account--update",
"api-reference/merchant-account/business-profile--list"
]
},
{
@ -56,6 +58,7 @@
"api-reference/business-profile/business-profile--create",
"api-reference/business-profile/business-profile--update",
"api-reference/business-profile/business-profile--retrieve",
"api-reference/business-profile/merchant-connector--list",
"api-reference/business-profile/business-profile--activate-routing-algorithm",
"api-reference/business-profile/business-profile--retrieve-active-routing-algorithm",
"api-reference/business-profile/business-profile--deactivate-routing-algorithm",
@ -86,6 +89,16 @@
"api-reference/routing/routing--create",
"api-reference/routing/routing--retrieve"
]
},
{
"group": "Customers",
"pages": [
"api-reference/customers/customers--create",
"api-reference/customers/customers--retrieve",
"api-reference/customers/customers--update",
"api-reference/customers/customers--delete",
"api-reference/customers/customers--list"
]
}
],
"footerSocials": {

6
api-reference-v2/openapi_spec.json
View File

@ -1438,8 +1438,8 @@
"tags": [
"Customers"
],
"summary": "Creates a customer object and stores the customer details to be reused for future payments.",
"description": "Incase the customer already exists in the system, this API will respond with the customer details.",
"summary": "Customers - Create",
"description": "Creates a customer object and stores the customer details to be reused for future payments.\nIncase the customer already exists in the system, this API will respond with the customer details.",
"operationId": "Create a Customer",
"requestBody": {
"content": {
@ -1622,7 +1622,7 @@
}
},
"/v2/customers/list": {
"post": {
"get": {
"tags": [
"Customers"
],

2
api-reference/api-reference/customers/customers--list.mdx
View File

@ -1,3 +1,3 @@
---
openapi: openapi_spec post /customers/list
openapi: openapi_spec get /customers/list
---

2
api-reference/openapi_spec.json
View File

@ -2304,7 +2304,7 @@
}
},
"/customers/list": {
"post": {
"get": {
"tags": [
"Customers"
],

6
crates/openapi/src/routes/customers.rs
View File

@ -93,7 +93,7 @@ pub async fn customers_delete() {}
///
/// Lists all the customers for a particular merchant id.
#[utoipa::path(
post,
get,
path = "/customers/list",
responses(
(status = 200, description = "Customers retrieved", body = Vec<CustomerResponse>),
@ -106,6 +106,8 @@ pub async fn customers_delete() {}
#[cfg(feature = "v1")]
pub async fn customers_list() {}
/// Customers - Create
///
/// Creates a customer object and stores the customer details to be reused for future payments.
/// Incase the customer already exists in the system, this API will respond with the customer details.
#[utoipa::path(
@ -199,7 +201,7 @@ pub async fn customers_delete() {}
///
/// Lists all the customers for a particular merchant id.
#[utoipa::path(
post,
get,
path = "/v2/customers/list",
responses(
(status = 200, description = "Customers retrieved", body = Vec<CustomerResponse>),