From 8db8417d9924e48032711ab95f57f3a24df150be Mon Sep 17 00:00:00 2001 From: Sonja Happ Date: Wed, 11 Aug 2021 16:58:49 +0200 Subject: [PATCH] CI: add missing statement, update api docs generated with swag --- .gitlab-ci.yml | 1 + doc/api/docs.go | 62 ++++++++++---------------------------------- doc/api/swagger.json | 62 ++++++++++---------------------------------- doc/api/swagger.yaml | 41 +++++++---------------------- 4 files changed, 36 insertions(+), 130 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 8efd2bb..df81d76 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -25,6 +25,7 @@ build: extends: .go script: - go mod tidy + - go get github.com/swaggo/swag/cmd/swag@v1.7.0 - go install github.com/swaggo/swag/cmd/swag - ${GOPATH}/bin/swag init --propertyStrategy pascalcase --generalInfo "start.go" diff --git a/doc/api/docs.go b/doc/api/docs.go index 17cf0eb..3e5486d 100644 --- a/doc/api/docs.go +++ b/doc/api/docs.go @@ -3415,58 +3415,16 @@ var doc = `{ "config.Config": { "type": "object", "properties": { - "authentication": { - "$ref": "#/definitions/config.ConfigAuthentication" - }, - "contact": { - "$ref": "#/definitions/config.ConfigContact" - }, - "mode": { - "type": "string" - }, - "sub_title": { - "type": "string" - }, - "title": { - "type": "string" + "Providers": { + "type": "array", + "items": { + "$ref": "#/definitions/config.Provider" + } } } }, - "config.ConfigAuthentication": { - "type": "object", - "properties": { - "external": { - "$ref": "#/definitions/config.ConfigAuthenticationExternal" - }, - "logout_url": { - "type": "string" - } - } - }, - "config.ConfigAuthenticationExternal": { - "type": "object", - "properties": { - "authorize_url": { - "type": "string" - }, - "enabled": { - "type": "boolean" - }, - "provider_name": { - "type": "string" - } - } - }, - "config.ConfigContact": { - "type": "object", - "properties": { - "mail": { - "type": "string" - }, - "name": { - "type": "string" - } - } + "config.Provider": { + "type": "object" }, "dashboard.addDashboardRequest": { "type": "object", @@ -3551,6 +3509,9 @@ var doc = `{ "Category": { "type": "string" }, + "CreateParameterSchema": { + "$ref": "#/definitions/postgres.Jsonb" + }, "Description": { "type": "string" }, @@ -3598,6 +3559,9 @@ var doc = `{ "Category": { "type": "string" }, + "CreateParameterSchema": { + "$ref": "#/definitions/postgres.Jsonb" + }, "Description": { "type": "string" }, diff --git a/doc/api/swagger.json b/doc/api/swagger.json index 32b02bb..ed6e590 100644 --- a/doc/api/swagger.json +++ b/doc/api/swagger.json @@ -3399,58 +3399,16 @@ "config.Config": { "type": "object", "properties": { - "authentication": { - "$ref": "#/definitions/config.ConfigAuthentication" - }, - "contact": { - "$ref": "#/definitions/config.ConfigContact" - }, - "mode": { - "type": "string" - }, - "sub_title": { - "type": "string" - }, - "title": { - "type": "string" + "Providers": { + "type": "array", + "items": { + "$ref": "#/definitions/config.Provider" + } } } }, - "config.ConfigAuthentication": { - "type": "object", - "properties": { - "external": { - "$ref": "#/definitions/config.ConfigAuthenticationExternal" - }, - "logout_url": { - "type": "string" - } - } - }, - "config.ConfigAuthenticationExternal": { - "type": "object", - "properties": { - "authorize_url": { - "type": "string" - }, - "enabled": { - "type": "boolean" - }, - "provider_name": { - "type": "string" - } - } - }, - "config.ConfigContact": { - "type": "object", - "properties": { - "mail": { - "type": "string" - }, - "name": { - "type": "string" - } - } + "config.Provider": { + "type": "object" }, "dashboard.addDashboardRequest": { "type": "object", @@ -3535,6 +3493,9 @@ "Category": { "type": "string" }, + "CreateParameterSchema": { + "$ref": "#/definitions/postgres.Jsonb" + }, "Description": { "type": "string" }, @@ -3582,6 +3543,9 @@ "Category": { "type": "string" }, + "CreateParameterSchema": { + "$ref": "#/definitions/postgres.Jsonb" + }, "Description": { "type": "string" }, diff --git a/doc/api/swagger.yaml b/doc/api/swagger.yaml index 5dcdc9f..b8534fb 100644 --- a/doc/api/swagger.yaml +++ b/doc/api/swagger.yaml @@ -85,39 +85,12 @@ definitions: type: object config.Config: properties: - authentication: - $ref: '#/definitions/config.ConfigAuthentication' - contact: - $ref: '#/definitions/config.ConfigContact' - mode: - type: string - sub_title: - type: string - title: - type: string + Providers: + items: + $ref: '#/definitions/config.Provider' + type: array type: object - config.ConfigAuthentication: - properties: - external: - $ref: '#/definitions/config.ConfigAuthenticationExternal' - logout_url: - type: string - type: object - config.ConfigAuthenticationExternal: - properties: - authorize_url: - type: string - enabled: - type: boolean - provider_name: - type: string - type: object - config.ConfigContact: - properties: - mail: - type: string - name: - type: string + config.Provider: type: object dashboard.addDashboardRequest: properties: @@ -169,6 +142,8 @@ definitions: type: string Category: type: string + CreateParameterSchema: + $ref: '#/definitions/postgres.Jsonb' Description: type: string Location: @@ -205,6 +180,8 @@ definitions: type: string Category: type: string + CreateParameterSchema: + $ref: '#/definitions/postgres.Jsonb' Description: type: string Location: