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.

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

chore: Update Swagger #56

Merged
merged 2 commits into from
Nov 16, 2022
Merged
Changes from all commits
Commits
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
40 changes: 27 additions & 13 deletions swagger.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
openapi: 3.0.0
openapi: 3.1.0
info:
title: Payments API
version: 1.0.0
paths:
'/payments':
/payments:
get:
summary: Returns a list of payments.
operationId: listPayments
tags:
- payments
- Payments
parameters:
- name: limit
in: query
Expand Down Expand Up @@ -37,12 +37,12 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ListPaymentsResponse'
'/payments/{paymentId}':
/payments/{paymentId}:
get:
summary: Returns a payment.
operationId: getPayment
tags:
- payments
- Payments
operationId: getPayment
parameters:
- name: paymentId
in: path
Expand All @@ -59,9 +59,11 @@ paths:
schema:
$ref: '#/components/schemas/Payment'

'/connectors':
/connectors:
get:
summary: Get all installed connectors
tags:
- Payments
operationId: getAllConnectors
description: Get all installed connectors
responses:
Expand All @@ -72,9 +74,11 @@ paths:
schema:
$ref: '#/components/schemas/ListConnectorsResponse'

'/connectors/{connector}':
/connectors/{connector}:
post:
summary: Install connector
tags:
- Payments
operationId: installConnector
description: Install connector
parameters:
Expand All @@ -100,6 +104,8 @@ paths:
description: Connector has been installed
delete:
summary: Uninstall connector
tags:
- Payments
operationId: uninstallConnector
description: Uninstall connector
parameters:
Expand All @@ -114,9 +120,11 @@ paths:
responses:
204:
description: Connector has been uninstalled
'/connectors/{connector}/config':
/connectors/{connector}/config:
get:
summary: Read connector config
tags:
- Payments
operationId: readConnectorConfig
description: Read connector config
parameters:
Expand All @@ -135,9 +143,11 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ConnectorConfig'
'/connectors/{connector}/reset':
/connectors/{connector}/reset:
post:
summary: Reset connector
tags:
- Payments
operationId: resetConnector
description: Reset connector. Will remove the connector and ALL PAYMENTS generated with it.
parameters:
Expand All @@ -152,9 +162,11 @@ paths:
responses:
204:
description: Connector has been reset
'/connectors/{connector}/tasks':
/connectors/{connector}/tasks:
get:
summary: List connector tasks
tags:
- Payments
operationId: listConnectorTasks
description: List all tasks associated with this connector.
parameters:
Expand All @@ -175,9 +187,11 @@ paths:
type: array
items:
$ref: '#/components/schemas/ConnectorTask'
'/connectors/{connector}/tasks/{taskId}':
/connectors/{connector}/tasks/{taskId}:
get:
summary: Read a specific task of the connector
tags:
- Payments
operationId: getConnectorTask
description: Get a specific task associated to the connector
parameters:
Expand Down Expand Up @@ -381,4 +395,4 @@ components:
example: stripe
disabled:
type: boolean
example: false
example: false