btcpayserver/BTCPayServer/wwwroot/swagger/v1/swagger.template.misc.json

{
    "paths": {
        "/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"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "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
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "security": []
            }
        },
        "/i/{invoiceId}": {
            "parameters": [
                {
                    "name": "invoiceId",
                    "in": "path",
                    "required": true,
                    "description": "The invoice id",
                    "schema": {
                        "type": "string"
                    }
                },
                {
                    "name": "lang",
                    "in": "query",
                    "required": false,
                    "description": "The preferred language of the checkout page. You can see the list of language codes with [this operation](#operation/langCodes).",
                    "schema": {
                        "type": "string"
                    }
                }
            ],
            "get": {
                "tags": [
                    "Miscelleneous"
                ],
                "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"
                            }
                        }
                    }
                },
                "security": []
            }
        }
    },
    "tags": [
        {
            "name": "Miscelleneous"
        }
    ]
}