docs: change organization_id to id in organization endpoints (#6218)

Co-authored-by: hyperswitch-bot[bot] <148525504+hyperswitch-bot[bot]@users.noreply.github.com>
This commit is contained in:
Hrithikesh
2024-10-04 18:53:54 +05:30
committed by GitHub
parent caa0693148
commit 939483cebe
8 changed files with 23 additions and 23 deletions

View File

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

View File

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

View File

@ -1,3 +1,3 @@
--- ---
openapi: put /v2/organization/{organization_id} openapi: put /v2/organization/{id}
--- ---

View File

@ -67,7 +67,7 @@
] ]
} }
}, },
"/v2/organization/{organization_id}": { "/v2/organization/{id}": {
"get": { "get": {
"tags": [ "tags": [
"Organization" "Organization"
@ -77,7 +77,7 @@
"operationId": "Retrieve an Organization", "operationId": "Retrieve an Organization",
"parameters": [ "parameters": [
{ {
"name": "organization_id", "name": "id",
"in": "path", "in": "path",
"description": "The unique identifier for the Organization", "description": "The unique identifier for the Organization",
"required": true, "required": true,
@ -116,7 +116,7 @@
"operationId": "Update an Organization", "operationId": "Update an Organization",
"parameters": [ "parameters": [
{ {
"name": "organization_id", "name": "id",
"in": "path", "in": "path",
"description": "The unique identifier for the Organization", "description": "The unique identifier for the Organization",
"required": true, "required": true,
@ -164,7 +164,7 @@
] ]
} }
}, },
"/v2/organization/{organization_id}/merchant_accounts": { "/v2/organization/{id}/merchant_accounts": {
"get": { "get": {
"tags": [ "tags": [
"Organization" "Organization"
@ -174,7 +174,7 @@
"operationId": "List Merchant Accounts", "operationId": "List Merchant Accounts",
"parameters": [ "parameters": [
{ {
"name": "organization_id", "name": "id",
"in": "path", "in": "path",
"description": "The unique identifier for the Organization", "description": "The unique identifier for the Organization",
"required": true, "required": true,

View File

@ -1,3 +1,3 @@
--- ---
openapi: get /organization/{organization_id} openapi: get /organization/{id}
--- ---

View File

@ -1,3 +1,3 @@
--- ---
openapi: put /organization/{organization_id} openapi: put /organization/{id}
--- ---

View File

@ -1156,7 +1156,7 @@
] ]
} }
}, },
"/organization/{organization_id}": { "/organization/{id}": {
"get": { "get": {
"tags": [ "tags": [
"Organization" "Organization"
@ -1166,7 +1166,7 @@
"operationId": "Retrieve an Organization", "operationId": "Retrieve an Organization",
"parameters": [ "parameters": [
{ {
"name": "organization_id", "name": "id",
"in": "path", "in": "path",
"description": "The unique identifier for the Organization", "description": "The unique identifier for the Organization",
"required": true, "required": true,
@ -1205,7 +1205,7 @@
"operationId": "Update an Organization", "operationId": "Update an Organization",
"parameters": [ "parameters": [
{ {
"name": "organization_id", "name": "id",
"in": "path", "in": "path",
"description": "The unique identifier for the Organization", "description": "The unique identifier for the Organization",
"required": true, "required": true,

View File

@ -31,8 +31,8 @@ pub async fn organization_create() {}
/// Retrieve an existing organization /// Retrieve an existing organization
#[utoipa::path( #[utoipa::path(
get, get,
path = "/organization/{organization_id}", path = "/organization/{id}",
params (("organization_id" = String, Path, description = "The unique identifier for the Organization")), params (("id" = String, Path, description = "The unique identifier for the Organization")),
responses( responses(
(status = 200, description = "Organization Created", body =OrganizationResponse), (status = 200, description = "Organization Created", body =OrganizationResponse),
(status = 400, description = "Invalid data") (status = 400, description = "Invalid data")
@ -49,7 +49,7 @@ pub async fn organization_retrieve() {}
/// Create a new organization for . /// Create a new organization for .
#[utoipa::path( #[utoipa::path(
put, put,
path = "/organization/{organization_id}", path = "/organization/{id}",
request_body( request_body(
content = OrganizationUpdateRequest, content = OrganizationUpdateRequest,
examples( examples(
@ -60,7 +60,7 @@ pub async fn organization_retrieve() {}
), ),
) )
), ),
params (("organization_id" = String, Path, description = "The unique identifier for the Organization")), params (("id" = String, Path, description = "The unique identifier for the Organization")),
responses( responses(
(status = 200, description = "Organization Created", body =OrganizationResponse), (status = 200, description = "Organization Created", body =OrganizationResponse),
(status = 400, description = "Invalid data") (status = 400, description = "Invalid data")
@ -104,8 +104,8 @@ pub async fn organization_create() {}
/// Retrieve an existing organization /// Retrieve an existing organization
#[utoipa::path( #[utoipa::path(
get, get,
path = "/v2/organization/{organization_id}", path = "/v2/organization/{id}",
params (("organization_id" = String, Path, description = "The unique identifier for the Organization")), params (("id" = String, Path, description = "The unique identifier for the Organization")),
responses( responses(
(status = 200, description = "Organization Created", body =OrganizationResponse), (status = 200, description = "Organization Created", body =OrganizationResponse),
(status = 400, description = "Invalid data") (status = 400, description = "Invalid data")
@ -122,7 +122,7 @@ pub async fn organization_retrieve() {}
/// Create a new organization for . /// Create a new organization for .
#[utoipa::path( #[utoipa::path(
put, put,
path = "/v2/organization/{organization_id}", path = "/v2/organization/{id}",
request_body( request_body(
content = OrganizationUpdateRequest, content = OrganizationUpdateRequest,
examples( examples(
@ -133,7 +133,7 @@ pub async fn organization_retrieve() {}
), ),
) )
), ),
params (("organization_id" = String, Path, description = "The unique identifier for the Organization")), params (("id" = String, Path, description = "The unique identifier for the Organization")),
responses( responses(
(status = 200, description = "Organization Created", body =OrganizationResponse), (status = 200, description = "Organization Created", body =OrganizationResponse),
(status = 400, description = "Invalid data") (status = 400, description = "Invalid data")
@ -150,8 +150,8 @@ pub async fn organization_update() {}
/// List merchant accounts for an Organization /// List merchant accounts for an Organization
#[utoipa::path( #[utoipa::path(
get, get,
path = "/v2/organization/{organization_id}/merchant_accounts", path = "/v2/organization/{id}/merchant_accounts",
params (("organization_id" = String, Path, description = "The unique identifier for the Organization")), params (("id" = String, Path, description = "The unique identifier for the Organization")),
responses( responses(
(status = 200, description = "Merchant Account list retrieved successfully", body = Vec<MerchantAccountResponse>), (status = 200, description = "Merchant Account list retrieved successfully", body = Vec<MerchantAccountResponse>),
(status = 400, description = "Invalid data") (status = 400, description = "Invalid data")