Cutlery/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2025-05-31 04:44:32 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update for docs

Browse Source
This commit is contained in:
David Bomba 2024-01-25 09:03:10 +11:00
parent c25cee6edf
commit fae98725b0
2 changed files with 30 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
openapi/api-docs.yaml
View File

@ -1359,7 +1359,7 @@ paths:
get: get:
tags: tags:
- client_gateway_tokens - client_gateway_tokens
summary: "List of client tokens" summary: "List of client payment tokens"
description: "Lists client_gateway_tokens, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the client_gateway_tokens, these are handled by the ClientGatewayTokenFilters class which defines the methods available" description: "Lists client_gateway_tokens, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the client_gateway_tokens, these are handled by the ClientGatewayTokenFilters class which defines the methods available"
operationId: getClientGatewayTokens operationId: getClientGatewayTokens
parameters: parameters:
@ -1400,8 +1400,8 @@ paths:
post: post:
tags: tags:
- client_gateway_tokens - client_gateway_tokens
summary: "Adds a client" summary: "Adds a client payment token"
description: "Adds an client to a company" description: "Adds a client payment token to a company"
operationId: storeClientGatewayToken operationId: storeClientGatewayToken
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
@ -1409,7 +1409,7 @@ paths:
- $ref: "#/components/parameters/include" - $ref: "#/components/parameters/include"
responses: responses:
200: 200:
description: "Returns the saved client object" description: "Returns the saved client payment token object"
headers: headers:
X-MINIMUM-CLIENT-VERSION: X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@ -1433,8 +1433,8 @@ paths:
get: get:
tags: tags:
- client_gateway_tokens - client_gateway_tokens
summary: "Shows a client" summary: "Shows a client payment token"
description: "Displays a client by id" description: "Displays a client payment token by id"
operationId: showClientGatewayToken operationId: showClientGatewayToken
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
@ -1450,7 +1450,7 @@ paths:
example: D2J234DFA example: D2J234DFA
responses: responses:
200: 200:
description: "Returns the cl.ient object" description: "Returns the client payment token object"
headers: headers:
X-MINIMUM-CLIENT-VERSION: X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@ -1473,8 +1473,8 @@ paths:
put: put:
tags: tags:
- client_gateway_tokens - client_gateway_tokens
summary: "Updates a client" summary: "Updates a client payment token"
description: "Handles the updating of a client by id" description: "Handles the updating of a client payment token by id"
operationId: updateClientGatewayToken operationId: updateClientGatewayToken
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
@ -1490,7 +1490,7 @@ paths:
example: D2J234DFA example: D2J234DFA
responses: responses:
200: 200:
description: "Returns the client object" description: "Returns the client payment token object"
headers: headers:
X-MINIMUM-CLIENT-VERSION: X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@ -1514,7 +1514,7 @@ paths:
tags: tags:
- client_gateway_tokens - client_gateway_tokens
summary: "Deletes a client" summary: "Deletes a client"
description: "Handles the deletion of a client by id" description: "Handles the deletion of a client payment token by id"
operationId: deleteClientGatewayToken operationId: deleteClientGatewayToken
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
@ -1550,7 +1550,7 @@ paths:
get: get:
tags: tags:
- client_gateway_tokens - client_gateway_tokens
summary: "Shows a client for editting" summary: "Shows a client payment token for editting"
description: "Displays a client by id" description: "Displays a client by id"
operationId: editClientGatewayToken operationId: editClientGatewayToken
parameters: parameters:
@ -1567,7 +1567,7 @@ paths:
example: D2J234DFA example: D2J234DFA
responses: responses:
200: 200:
description: "Returns the client object" description: "Returns the client payment token object"
headers: headers:
X-MINIMUM-CLIENT-VERSION: X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@ -1591,7 +1591,7 @@ paths:
get: get:
tags: tags:
- client_gateway_tokens - client_gateway_tokens
summary: "Gets a new blank client object" summary: "Gets a new blank client payment token object"
description: "Returns a blank object with default values" description: "Returns a blank object with default values"
operationId: getClientGatewayTokensCreate operationId: getClientGatewayTokensCreate
parameters: parameters:
@ -1600,7 +1600,7 @@ paths:
- $ref: "#/components/parameters/include" - $ref: "#/components/parameters/include"
responses: responses:
200: 200:
description: "A blank client object" description: "A blank client payment token object"
headers: headers:
X-MINIMUM-CLIENT-VERSION: X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"

30
openapi/paths.yaml
View File

@ -1335,7 +1335,7 @@ paths:
get: get:
tags: tags:
- client_gateway_tokens - client_gateway_tokens
summary: "List of client tokens" summary: "List of client payment tokens"
description: "Lists client_gateway_tokens, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the client_gateway_tokens, these are handled by the ClientGatewayTokenFilters class which defines the methods available" description: "Lists client_gateway_tokens, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the client_gateway_tokens, these are handled by the ClientGatewayTokenFilters class which defines the methods available"
operationId: getClientGatewayTokens operationId: getClientGatewayTokens
parameters: parameters:
@ -1376,8 +1376,8 @@ paths:
post: post:
tags: tags:
- client_gateway_tokens - client_gateway_tokens
summary: "Adds a client" summary: "Adds a client payment token"
description: "Adds an client to a company" description: "Adds a client payment token to a company"
operationId: storeClientGatewayToken operationId: storeClientGatewayToken
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
@ -1385,7 +1385,7 @@ paths:
- $ref: "#/components/parameters/include" - $ref: "#/components/parameters/include"
responses: responses:
200: 200:
description: "Returns the saved client object" description: "Returns the saved client payment token object"
headers: headers:
X-MINIMUM-CLIENT-VERSION: X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@ -1409,8 +1409,8 @@ paths:
get: get:
tags: tags:
- client_gateway_tokens - client_gateway_tokens
summary: "Shows a client" summary: "Shows a client payment token"
description: "Displays a client by id" description: "Displays a client payment token by id"
operationId: showClientGatewayToken operationId: showClientGatewayToken
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
@ -1426,7 +1426,7 @@ paths:
example: D2J234DFA example: D2J234DFA
responses: responses:
200: 200:
description: "Returns the cl.ient object" description: "Returns the client payment token object"
headers: headers:
X-MINIMUM-CLIENT-VERSION: X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@ -1449,8 +1449,8 @@ paths:
put: put:
tags: tags:
- client_gateway_tokens - client_gateway_tokens
summary: "Updates a client" summary: "Updates a client payment token"
description: "Handles the updating of a client by id" description: "Handles the updating of a client payment token by id"
operationId: updateClientGatewayToken operationId: updateClientGatewayToken
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
@ -1466,7 +1466,7 @@ paths:
example: D2J234DFA example: D2J234DFA
responses: responses:
200: 200:
description: "Returns the client object" description: "Returns the client payment token object"
headers: headers:
X-MINIMUM-CLIENT-VERSION: X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@ -1490,7 +1490,7 @@ paths:
tags: tags:
- client_gateway_tokens - client_gateway_tokens
summary: "Deletes a client" summary: "Deletes a client"
description: "Handles the deletion of a client by id" description: "Handles the deletion of a client payment token by id"
operationId: deleteClientGatewayToken operationId: deleteClientGatewayToken
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
@ -1526,7 +1526,7 @@ paths:
get: get:
tags: tags:
- client_gateway_tokens - client_gateway_tokens
summary: "Shows a client for editting" summary: "Shows a client payment token for editting"
description: "Displays a client by id" description: "Displays a client by id"
operationId: editClientGatewayToken operationId: editClientGatewayToken
parameters: parameters:
@ -1543,7 +1543,7 @@ paths:
example: D2J234DFA example: D2J234DFA
responses: responses:
200: 200:
description: "Returns the client object" description: "Returns the client payment token object"
headers: headers:
X-MINIMUM-CLIENT-VERSION: X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@ -1567,7 +1567,7 @@ paths:
get: get:
tags: tags:
- client_gateway_tokens - client_gateway_tokens
summary: "Gets a new blank client object" summary: "Gets a new blank client payment token object"
description: "Returns a blank object with default values" description: "Returns a blank object with default values"
operationId: getClientGatewayTokensCreate operationId: getClientGatewayTokensCreate
parameters: parameters:
@ -1576,7 +1576,7 @@ paths:
- $ref: "#/components/parameters/include" - $ref: "#/components/parameters/include"
responses: responses:
200: 200:
description: "A blank client object" description: "A blank client payment token object"
headers: headers:
X-MINIMUM-CLIENT-VERSION: X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"