From 1dc9cff8d712dc9f9a885fca651e5b701f8506ef Mon Sep 17 00:00:00 2001 From: vil02 <65706193+vil02@users.noreply.github.com> Date: Tue, 15 Oct 2024 12:51:18 +0200 Subject: [PATCH] docs(openapi): improve `rust_locker_open_api_spec` --- api-reference-v2/rust_locker_open_api_spec.yml | 8 ++++---- api-reference/rust_locker_open_api_spec.yml | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/api-reference-v2/rust_locker_open_api_spec.yml b/api-reference-v2/rust_locker_open_api_spec.yml index 729886d9cd0..17a19fec44d 100644 --- a/api-reference-v2/rust_locker_open_api_spec.yml +++ b/api-reference-v2/rust_locker_open_api_spec.yml @@ -2,16 +2,16 @@ openapi: "3.0.2" info: title: Tartarus - OpenAPI 3.0 description: |- - This the the open API 3.0 specification for the card locker. + This is the OpenAPI 3.0 specification for the card locker. This is used by the [hyperswitch](https://github.com/juspay/hyperswitch) for storing card information securely. version: "1.0" tags: - name: Key Custodian description: API used to initialize the locker after deployment. - name: Data - description: CRUD APIs to for working with data to be stored in the locker + description: CRUD APIs for working with data to be stored in the locker - name: Cards - description: CRUD APIs to for working with cards data to be stored in the locker (deprecated) + description: CRUD APIs for working with cards data to be stored in the locker (deprecated) paths: /custodian/key1: post: @@ -39,7 +39,7 @@ paths: tags: - Key Custodian summary: Provide Key 2 - description: Provide the first key to unlock the locker + description: Provide the second key to unlock the locker operationId: setKey2 requestBody: description: Provide key 2 to unlock the locker diff --git a/api-reference/rust_locker_open_api_spec.yml b/api-reference/rust_locker_open_api_spec.yml index 729886d9cd0..17a19fec44d 100644 --- a/api-reference/rust_locker_open_api_spec.yml +++ b/api-reference/rust_locker_open_api_spec.yml @@ -2,16 +2,16 @@ openapi: "3.0.2" info: title: Tartarus - OpenAPI 3.0 description: |- - This the the open API 3.0 specification for the card locker. + This is the OpenAPI 3.0 specification for the card locker. This is used by the [hyperswitch](https://github.com/juspay/hyperswitch) for storing card information securely. version: "1.0" tags: - name: Key Custodian description: API used to initialize the locker after deployment. - name: Data - description: CRUD APIs to for working with data to be stored in the locker + description: CRUD APIs for working with data to be stored in the locker - name: Cards - description: CRUD APIs to for working with cards data to be stored in the locker (deprecated) + description: CRUD APIs for working with cards data to be stored in the locker (deprecated) paths: /custodian/key1: post: @@ -39,7 +39,7 @@ paths: tags: - Key Custodian summary: Provide Key 2 - description: Provide the first key to unlock the locker + description: Provide the second key to unlock the locker operationId: setKey2 requestBody: description: Provide key 2 to unlock the locker