From 43779d92c50ed5656f0ef330f89c10b47b2aaccf Mon Sep 17 00:00:00 2001 From: arcapas Date: Tue, 6 Aug 2024 15:22:48 -0300 Subject: [PATCH] test commit --- README.md | 2 +- openAPI/merchants_api.yml | 32 +++++++++++++++++++++++++++++++- 2 files changed, 32 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6f9eb1c..374d259 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,3 @@ # boomfi-docs -Supporting repository for BoomFi Docs. +Supporting repository for BoomFi Docs. diff --git a/openAPI/merchants_api.yml b/openAPI/merchants_api.yml index 000c34d..968190c 100644 --- a/openAPI/merchants_api.yml +++ b/openAPI/merchants_api.yml @@ -14,7 +14,37 @@ paths: get: security: - ApiKeyAuth: [] - description: This endpoint retrieves information about the organization. + description: | + The `Get Organization` endpoint is designed to retrieve detailed information about the organization. + + **HTTP Request:** + - **Method:** `GET` + - **URL:** `https://mapi.boomfi.xyz/v1/orgs` + + **Headers:** + - `accept: application/json` + - `x-api-key: ` + + #### Example Request + + ```shell + curl --request GET \ + --url https://mapi.boomfi.xyz/v1/orgs \ + --header 'accept: application/json' + ``` + + #### Response Codes + - **200 OK:** The request was successful, and the organization information is returned. + - **400 Bad Request:** The request was invalid, likely due to missing or incorrect parameters. + - **401 Unauthorized:** Authentication failed, usually due to an invalid or missing API key. + - **500 Internal Server Error:** An error occurred on the server, indicating a problem with processing the request. + + #### Key Points + - Use the provided `x-api-key` for authentication in the request headers. + - Handle different HTTP response codes to manage success and error scenarios appropriately. + - Ensure secure handling of the API key to prevent unauthorized access. + + consumes: - application/json produces: