mirror of
https://github.com/btcpayserver/btcpayserver.git
synced 2025-02-24 06:47:50 +01:00
7db510b5ca
* Fix linting errors * Fix linting warnings * Fix inconsistend indentation and unify formatting * Extract StoreId schemas * Extract CryptoCode parameter * Extract AppId parameter * More StoreId parameter references * Extract WebhookId and DeliveryId parameters * Extract InvoiceId parameter * Formatting
203 lines
8.4 KiB
JSON
203 lines
8.4 KiB
JSON
{
|
|
"paths": {
|
|
"/misc/rate-sources": {
|
|
"get": {
|
|
"tags": [
|
|
"Miscelleneous"
|
|
],
|
|
"summary": "Get available rate sources",
|
|
"description": "View available rate providers that you can use in stores",
|
|
"operationId": "GetRateSources",
|
|
"responses": {
|
|
"200": {
|
|
"description": "rate providers array",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "The id of the rate provider"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "The name of the rate provider"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "If you are authenticated but forbidden to get the data"
|
|
},
|
|
"default": {
|
|
"description": "Unexpected error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": []
|
|
}
|
|
},
|
|
"/misc/permissions": {
|
|
"get": {
|
|
"tags": [
|
|
"Miscelleneous"
|
|
],
|
|
"summary": "Permissions metadata",
|
|
"description": "The metadata of available permissions",
|
|
"operationId": "permissionsMetadata",
|
|
"responses": {
|
|
"200": {
|
|
"description": "The metadata of available permissions",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"description": "The permission id",
|
|
"nullable": false
|
|
},
|
|
"included": {
|
|
"type": "array",
|
|
"description": "Permissions included in this array are also granted by this permission",
|
|
"nullable": false,
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "If you are authenticated but forbidden to get the data"
|
|
},
|
|
"default": {
|
|
"description": "Unexpected error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": []
|
|
}
|
|
},
|
|
"/misc/lang": {
|
|
"get": {
|
|
"tags": [
|
|
"Miscelleneous"
|
|
],
|
|
"summary": "Language codes",
|
|
"description": "The supported language codes",
|
|
"operationId": "langCodes",
|
|
"responses": {
|
|
"200": {
|
|
"description": "The supported language codes",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"description": "The language code",
|
|
"nullable": false
|
|
},
|
|
"currentLanguage": {
|
|
"type": "string",
|
|
"description": "The language name",
|
|
"nullable": false
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "If you are authenticated but forbidden to get the data"
|
|
},
|
|
"default": {
|
|
"description": "Unexpected error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ProblemDetails"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": []
|
|
}
|
|
},
|
|
"/i/{invoiceId}": {
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/InvoiceId"
|
|
},
|
|
{
|
|
"name": "lang",
|
|
"in": "query",
|
|
"required": false,
|
|
"description": "The preferred language of the checkout page. You can use \"auto\" to use the language of the customer's browser or see the list of language codes with [this operation](#operation/langCodes).",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"tags": [
|
|
"Miscelleneous"
|
|
],
|
|
"operationId": "Invoice_Checkout",
|
|
"summary": "Invoice checkout",
|
|
"description": "View the checkout page of an invoice",
|
|
"responses": {
|
|
"200": {
|
|
"description": "The checkout page",
|
|
"content": {
|
|
"text/html": {
|
|
"example": "The HTML checkout page of the invoice"
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "The invoice could not be found"
|
|
}
|
|
},
|
|
"security": []
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
{
|
|
"name": "Miscelleneous",
|
|
"description": "Miscelleneous operations"
|
|
}
|
|
]
|
|
}
|