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.

Sign up for GitHub

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

Jump to bottom

docs(openapi): improve rust_locker_open_api_spec #6322

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(openapi): improve rust_locker_open_api_spec #6322

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions api-reference-v2/rust_locker_open_api_spec.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions api-reference/rust_locker_open_api_spec.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down
Loading