mirrors/homebox
1
0
Fork 0
mirror of https://github.com/sysadminsmedia/homebox.git synced 2025-12-24 06:28:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

fix: API URLs for docs (#599)

Browse Source 
* fix: API URLs for docs

* fix: merge issue
This commit is contained in:
Matt Kilgore
2025-03-22 12:04:52 -04:00
committed by GitHub
parent e216d46848
commit d5b062cd62
6 changed files with 15 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
backend/app/api/main.go
View File

@@ -66,7 +66,9 @@ func validatePostgresSSLMode(sslMode string) bool {
// @title Homebox API // @title Homebox API
// @version 1.0 // @version 1.0
// @description Track, Manage, and Organize your Things. // @description Track, Manage, and Organize your Things.
// @contact.name Don't // @contact.name Homebox Team
// @contact.url https://discord.homebox.software
// @host demo.homebox.software
// @BasePath /api // @BasePath /api
// @securityDefinitions.apikey Bearer // @securityDefinitions.apikey Bearer
// @in header // @in header

5
backend/app/api/static/docs/docs.go
View File

@@ -10,7 +10,8 @@ const docTemplate = `{
"description": "{{escape .Description}}", "description": "{{escape .Description}}",
"title": "{{.Title}}", "title": "{{.Title}}",
"contact": { "contact": {
"name": "Don't" "name": "Homebox Team",
"url": "https://discord.homebox.software"
}, },
"version": "{{.Version}}" "version": "{{.Version}}"
}, },
@@ -3262,7 +3263,7 @@ const docTemplate = `{
// SwaggerInfo holds exported Swagger Info so clients can modify it // SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo = &swag.Spec{ var SwaggerInfo = &swag.Spec{
Version: "1.0", Version: "1.0",
Host: "", Host: "demo.homebox.software",
BasePath: "/api", BasePath: "/api",
Schemes: []string{}, Schemes: []string{},
Title: "Homebox API", Title: "Homebox API",

4
backend/app/api/static/docs/swagger.json
View File

@@ -4,10 +4,12 @@
"description": "Track, Manage, and Organize your Things.", "description": "Track, Manage, and Organize your Things.",
"title": "Homebox API", "title": "Homebox API",
"contact": { "contact": {
"name": "Don't" "name": "Homebox Team",
"url": "https://discord.homebox.software"
}, },
"version": "1.0" "version": "1.0"
}, },
"host": "demo.homebox.software",
"basePath": "/api", "basePath": "/api",
"paths": { "paths": {
"/v1/actions/ensure-asset-ids": { "/v1/actions/ensure-asset-ids": {

4
backend/app/api/static/docs/swagger.yaml
View File

@@ -772,9 +772,11 @@ definitions:
fields: fields:
type: string type: string
type: object type: object
host: demo.homebox.software
info: info:
contact: contact:
name: Don't name: Homebox Team
url: https://discord.homebox.software
description: Track, Manage, and Organize your Things. description: Track, Manage, and Organize your Things.
title: Homebox API title: Homebox API
version: "1.0" version: "1.0"

4
docs/docs/api/openapi-2.0.json
View File

@@ -4,10 +4,12 @@
"description": "Track, Manage, and Organize your Things.", "description": "Track, Manage, and Organize your Things.",
"title": "Homebox API", "title": "Homebox API",
"contact": { "contact": {
"name": "Don't" "name": "Homebox Team",
"url": "https://discord.homebox.software"
}, },
"version": "1.0" "version": "1.0"
}, },
"host": "demo.homebox.software",
"basePath": "/api", "basePath": "/api",
"paths": { "paths": {
"/v1/actions/ensure-asset-ids": { "/v1/actions/ensure-asset-ids": {

6
docs/en/api.md
View File

@@ -38,12 +38,6 @@ if (isDark.value) {
} }
</script> </script>
<style>
.TryItPanel {
display: none;
}
</style>
<client-only> <client-only>
<elements-api <elements-api
:key="componentKey" :key="componentKey"