Skip to content

Commit

Permalink
docs(openapi): improve rust_locker_open_api_spec
Browse files Browse the repository at this point in the history
  • Loading branch information
vil02 committed Oct 18, 2024
1 parent 0bda934 commit 89d4847
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions api-reference-v2/rust_locker_open_api_spec.yml
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
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

0 comments on commit 89d4847

Please sign in to comment.