Chore: fix formating for swagger definitions (#54993)

This commit is contained in:
Sofia Papagiannaki
2022-09-12 10:40:35 +03:00
committed by GitHub
parent 7979463bbf
commit b157fcdd87
12 changed files with 97 additions and 97 deletions
+2 -2
View File
@@ -243,7 +243,7 @@ func (hs *HTTPServer) GetAlertNotifiers(ngalertEnabled bool) func(*models.ReqCon
// swagger:route GET /alert-notifications/lookup legacy_alerts_notification_channels getAlertNotificationLookup
//
// Get all notification channels (lookup)
// Get all notification channels (lookup).
//
// Returns all notification channels, but with less detailed information. Accessible by any authenticated user and is mainly used by providing alert notification channels in Grafana UI when configuring alert rule.
//
@@ -342,7 +342,7 @@ func (hs *HTTPServer) GetAlertNotificationByID(c *models.ReqContext) response.Re
// swagger:route GET /alert-notifications/uid/{notification_channel_uid} legacy_alerts_notification_channels getAlertNotificationChannelByUID
//
// Get notification channel by UID
// Get notification channel by UID.
//
// Returns the notification channel given the notification channel UID.
//
+2 -2
View File
@@ -297,7 +297,7 @@ func (hs *HTTPServer) UpdateAnnotation(c *models.ReqContext) response.Response {
// swagger:route PATCH /annotations/{annotation_id} annotations patchAnnotation
//
// Patch Annotation
// Patch Annotation.
//
// Updates one or more properties of an annotation that matches the specified ID.
// This operation currently supports updating of the `text`, `tags`, `time` and `timeEnd` properties.
@@ -442,7 +442,7 @@ func (hs *HTTPServer) MassDeleteAnnotations(c *models.ReqContext) response.Respo
// swagger:route GET /annotations/{annotation_id} annotations getAnnotationByID
//
// Get Annotation by Id.
// Get Annotation by ID.
//
// Responses:
// 200: getAnnotationByIDResponse
+19 -19
View File
@@ -3,29 +3,29 @@
// The Grafana backend exposes an HTTP API, the same API is used by the frontend to do
// everything from saving dashboards, creating users and updating data sources.
//
// Schemes: http, https
// BasePath: /api
// Version: 0.0.1
// License: GNU Affero General Public License v3.0 https://www.gnu.org/licenses/agpl-3.0.en.html
// Contact: Grafana Labs<hello@grafana.com> https://grafana.com
// Schemes: http, https
// BasePath: /api
// Version: 0.0.1
// License: GNU Affero General Public License v3.0 https://www.gnu.org/licenses/agpl-3.0.en.html
// Contact: Grafana Labs<hello@grafana.com> https://grafana.com
//
// Consumes:
// - application/json
// Consumes:
// - application/json
//
// Produces:
// - application/json
// Produces:
// - application/json
//
// Security:
// - basic:
// - api_key:
// Security:
// - basic:
// - api_key:
//
// SecurityDefinitions:
// basic:
// type: basic
// api_key:
// type: apiKey
// name: Authorization
// in: header
// SecurityDefinitions:
// basic:
// type: basic
// api_key:
// type: apiKey
// name: Authorization
// in: header
//
// swagger:meta
package api
+1 -1
View File
@@ -95,7 +95,7 @@ func (hs *HTTPServer) DeleteAPIKey(c *models.ReqContext) response.Response {
//
// Creates an API key.
//
// Will return details of the created API key
// Will return details of the created API key.
//
// Responses:
// 200: postAPIkeyResponse
+1 -1
View File
@@ -46,7 +46,7 @@ func (hs *HTTPServer) handleQueryMetricsError(err error) *response.NormalRespons
// QueryMetricsV2 returns query metrics.
// swagger:route POST /ds/query ds queryMetricsWithExpressions
//
// DataSource query metrics with expressions
// DataSource query metrics with expressions.
//
// If you are running Grafana Enterprise and have Fine-grained access control enabled
// you need to have a permission with action: `datasources:query`.
+2 -2
View File
@@ -18,7 +18,7 @@ import (
// swagger:route GET /org org getCurrentOrg
//
// Get current Organization
// Get current Organization.
//
// Responses:
// 200: getCurrentOrgResponse
@@ -301,7 +301,7 @@ func (hs *HTTPServer) DeleteOrgByID(c *models.ReqContext) response.Response {
// swagger:route GET /orgs orgs searchOrgs
//
// Search all Organizations
// Search all Organizations.
//
// Security:
// - basic:
+5 -5
View File
@@ -18,7 +18,7 @@ import (
// swagger:route POST /org/users org addOrgUserToCurrentOrg
//
// Add a new user to the current organization
// Add a new user to the current organization.
//
// Adds a global user to the current organization.
//
@@ -41,7 +41,7 @@ func (hs *HTTPServer) AddOrgUserToCurrentOrg(c *models.ReqContext) response.Resp
// swagger:route POST /orgs/{org_id}/users orgs addOrgUser
//
// Add a new user to the current organization
// Add a new user to the current organization.
//
// Adds a global user to the current organization.
//
@@ -275,7 +275,7 @@ func (hs *HTTPServer) SearchOrgUsersWithPaging(c *models.ReqContext) response.Re
// swagger:route PATCH /org/users/{user_id} org updateOrgUserForCurrentOrg
//
// Updates the given user
// Updates the given user.
//
// If you are running Grafana Enterprise and have Fine-grained access control enabled
// you need to have a permission with action: `org.users.role:update` with scope `users:*`.
@@ -349,7 +349,7 @@ func (hs *HTTPServer) updateOrgUserHelper(c *models.ReqContext, cmd models.Updat
// swagger:route DELETE /org/users/{user_id} org removeOrgUserForCurrentOrg
//
// Delete user in current organization
// Delete user in current organization.
//
// If you are running Grafana Enterprise and have Fine-grained access control enabled
// you need to have a permission with action: `org.users:remove` with scope `users:*`.
@@ -375,7 +375,7 @@ func (hs *HTTPServer) RemoveOrgUserForCurrentOrg(c *models.ReqContext) response.
// swagger:route DELETE /orgs/{org_id}/users/{user_id} orgs removeOrgUser
//
// Delete user in current organization
// Delete user in current organization.
//
// If you are running Grafana Enterprise and have Fine-grained access control enabled
// you need to have a permission with action: `org.users:remove` with scope `users:*`.
+1 -1
View File
@@ -19,7 +19,7 @@ func (hs *HTTPServer) GetCurrentOrgQuotas(c *models.ReqContext) response.Respons
// Fetch Organization quota.
//
// If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `orgs.quotas:read` and scope `org:id:1` (orgIDScope).
//list
//
// Responses:
// 200: getQuotaResponse
// 401: unauthorisedError
+1 -1
View File
@@ -131,7 +131,7 @@ func (hs *HTTPServer) searchHitsWithMetadata(c *models.ReqContext, hits models.H
// swagger:route GET /search/sorting search listSortOptions
//
// List search sorting options
// List search sorting options.
//
// Responses:
// 200: listSortOptionsResponse