mirror of
https://github.com/sysadminsmedia/homebox.git
synced 2025-12-21 13:23:14 +01:00
Mk/fix api docs (#601)
* fix: API URLs for docs * fix: merge issue * fix: Lets try this again with some minor changes
This commit is contained in:
@@ -69,11 +69,13 @@ func validatePostgresSSLMode(sslMode string) bool {
|
||||
// @contact.name Homebox Team
|
||||
// @contact.url https://discord.homebox.software
|
||||
// @host demo.homebox.software
|
||||
// @schemes https http
|
||||
// @BasePath /api
|
||||
// @securityDefinitions.apikey Bearer
|
||||
// @in header
|
||||
// @name Authorization
|
||||
// @description "Type 'Bearer TOKEN' to correctly set the API Key"
|
||||
// @externalDocs.url https://homebox.software/en/api
|
||||
|
||||
func main() {
|
||||
zerolog.ErrorStackMarshaler = pkgerrors.MarshalStack
|
||||
|
||||
@@ -3265,7 +3265,7 @@ var SwaggerInfo = &swag.Spec{
|
||||
Version: "1.0",
|
||||
Host: "demo.homebox.software",
|
||||
BasePath: "/api",
|
||||
Schemes: []string{},
|
||||
Schemes: []string{"https", "http"},
|
||||
Title: "Homebox API",
|
||||
Description: "Track, Manage, and Organize your Things.",
|
||||
InfoInstanceName: "swagger",
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
{
|
||||
"schemes": [
|
||||
"https",
|
||||
"http"
|
||||
],
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"description": "Track, Manage, and Organize your Things.",
|
||||
|
||||
@@ -2045,6 +2045,9 @@ paths:
|
||||
summary: Update Account
|
||||
tags:
|
||||
- User
|
||||
schemes:
|
||||
- https
|
||||
- http
|
||||
securityDefinitions:
|
||||
Bearer:
|
||||
description: '"Type ''Bearer TOKEN'' to correctly set the API Key"'
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
{
|
||||
"schemes": [
|
||||
"https",
|
||||
"http"
|
||||
],
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"description": "Track, Manage, and Organize your Things.",
|
||||
|
||||
@@ -50,7 +50,7 @@ document.head.appendChild(elementStyle);
|
||||
<client-only>
|
||||
<elements-api
|
||||
:key="componentKey"
|
||||
apiDescriptionUrl="https://cdn.jsdelivr.net/gh/sysadminsmedia/homebox@main/docs/docs/api/openapi-2.0.json"
|
||||
apiDescriptionUrl="https://cdn.jsdelivr.net/gh/sysadminsmedia/homebox@main/docs/docs/api/openapi-2.0.yaml"
|
||||
router="hash"
|
||||
layout="responsive"
|
||||
hideSchemas="true"
|
||||
|
||||
Reference in New Issue
Block a user