Skip to content

A continuation of HomeBox the inventory and organization system built for the Home User

Mk/fix api docs (#601)

Matt Kilgore41ff4c4664aa
diff --git a/backend/app/api/main.go b/backend/app/api/main.go
index e8ad3306..3a6a372b 100644
--- a/backend/app/api/main.go
+++ b/backend/app/api/main.go
@@ -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
diff --git a/backend/app/api/static/docs/docs.go b/backend/app/api/static/docs/docs.go
index d8f364c0..ee155891 100644
--- a/backend/app/api/static/docs/docs.go
+++ b/backend/app/api/static/docs/docs.go
@@ -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",
diff --git a/backend/app/api/static/docs/swagger.json b/backend/app/api/static/docs/swagger.json
index c67f86ea..88fde4e7 100644
--- a/backend/app/api/static/docs/swagger.json
+++ b/backend/app/api/static/docs/swagger.json
@@ -1,4 +1,8 @@
{
+ "schemes": [
+ "https",
+ "http"
+ ],
"swagger": "2.0",
"info": {
"description": "Track, Manage, and Organize your Things.",
diff --git a/backend/app/api/static/docs/swagger.yaml b/backend/app/api/static/docs/swagger.yaml
index 1a983ac9..8e5c5bd6 100644
--- a/backend/app/api/static/docs/swagger.yaml
+++ b/backend/app/api/static/docs/swagger.yaml
@@ -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"'
diff --git a/docs/docs/api/openapi-2.0.json b/docs/docs/api/openapi-2.0.json
index 09c2eb94..88fde4e7 100644
--- a/docs/docs/api/openapi-2.0.json
+++ b/docs/docs/api/openapi-2.0.json
@@ -1,4 +1,8 @@
{
+ "schemes": [
+ "https",
+ "http"
+ ],
"swagger": "2.0",
"info": {
"description": "Track, Manage, and Organize your Things.",
@@ -3252,4 +3256,4 @@
"in": "header"
}
}
-}
+}
\ No newline at end of file
diff --git a/docs/en/api.md b/docs/en/api.md
index fb9d1536..7b077df6 100644
--- a/docs/en/api.md
+++ b/docs/en/api.md
@@ -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"