forked from grafana/grafana
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Query history: Add swagger definitions (grafana#50498)
* Query history: Add swagger definitions * Update * Remove changes in generated files * Generate api files * Add query history into api docs * Add examples for commands * Add missing parameters * Generate api-spec and api-merged * Fix linting * Fix showing of example of queries * Revert "Fix showing of example of queries" This reverts commit b1eb073. * Update * Update
- Loading branch information
1 parent
088a188
commit 0ddb3b7
Showing
9 changed files
with
1,211 additions
and
56 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| package definitions | ||
|
|
||
| import ( | ||
| "github.com/grafana/grafana/pkg/services/queryhistory" | ||
| ) | ||
|
|
||
| // swagger:route GET /query-history query_history searchQueries | ||
| // | ||
| // Query history search. | ||
| // | ||
| // Returns a list of queries in the query history that matches the search criteria. | ||
| // Query history search supports pagination. Use the `limit` parameter to control the maximum number of queries returned; the default limit is 100. | ||
| // You can also use the `page` query parameter to fetch queries from any page other than the first one. | ||
| // | ||
| // Responses: | ||
| // 200: getQueryHistorySearchResponse | ||
| // 401: unauthorisedError | ||
| // 500: internalServerError | ||
|
|
||
| // swagger:route POST /query-history query_history createQuery | ||
| // | ||
| // Add query to query history. | ||
| // | ||
| // Adds new query to query history. | ||
| // | ||
| // Responses: | ||
| // 200: getQueryHistoryResponse | ||
| // 400: badRequestError | ||
| // 401: unauthorisedError | ||
| // 500: internalServerError | ||
|
|
||
| // swagger:route POST /query-history/star/{query_history_uid} query_history starQuery | ||
| // | ||
| // Add star to query in query history. | ||
| // | ||
| // Adds star to query in query history as specified by the UID. | ||
| // | ||
| // Responses: | ||
| // 200: getQueryHistoryResponse | ||
| // 401: unauthorisedError | ||
| // 500: internalServerError | ||
|
|
||
| // swagger:route POST /query-history/migrate query_history migrateQueries | ||
| // | ||
| // Migrate queries to query history. | ||
| // | ||
| // Adds multiple queries to query history. | ||
| // | ||
| // Responses: | ||
| // 200: getQueryHistoryMigrationResponse | ||
| // 400: badRequestError | ||
| // 401: unauthorisedError | ||
| // 500: internalServerError | ||
|
|
||
| // swagger:route PATCH /query-history/{query_history_uid} query_history patchQueryComment | ||
| // | ||
| // Update comment for query in query history. | ||
| // | ||
| // Updates comment for query in query history as specified by the UID. | ||
| // | ||
| // Responses: | ||
| // 200: getQueryHistoryResponse | ||
| // 400: badRequestError | ||
| // 401: unauthorisedError | ||
| // 500: internalServerError | ||
|
|
||
| // swagger:route DELETE /query-history/{query_history_uid} query_history deleteQuery | ||
| // | ||
| // Delete query in query history. | ||
| // | ||
| // Deletes an existing query in query history as specified by the UID. This operation cannot be reverted. | ||
| // | ||
| // Responses: | ||
| // 200: getQueryHistoryDeleteQueryResponse | ||
| // 401: unauthorisedError | ||
| // 500: internalServerError | ||
|
|
||
| // swagger:route DELETE /query-history/star/{query_history_uid} query_history unstarQuery | ||
| // | ||
| // Remove star to query in query history. | ||
| // | ||
| // Removes star from query in query history as specified by the UID. | ||
| // | ||
| // Responses: | ||
| // 200: getQueryHistoryResponse | ||
| // 401: unauthorisedError | ||
| // 500: internalServerError | ||
|
|
||
| // swagger:parameters starQuery patchQueryComment deleteQuery unstarQuery | ||
| type QueryHistoryByUID struct { | ||
| // in:path | ||
| // required:true | ||
| UID string `json:"query_history_uid"` | ||
| } | ||
|
|
||
| // swagger:parameters searchQueries | ||
| type SearchQueriesParams struct { | ||
| // List of data source UIDs to search for | ||
| // in:query | ||
| // required: false | ||
| // type: array | ||
| // collectionFormat: multi | ||
| DatasourceUid []string `json:"datasourceUid"` | ||
| // Text inside query or comments that is searched for | ||
| // in:query | ||
| // required: false | ||
| SearchString string `json:"searchString"` | ||
| // Flag indicating if only starred queries should be returned | ||
| // in:query | ||
| // required: false | ||
| OnlyStarred bool `json:"onlyStarred"` | ||
| // Sort method | ||
| // in:query | ||
| // required: false | ||
| // default: time-desc | ||
| // Enum: time-desc,time-asc | ||
| Sort string `json:"sort"` | ||
| // Use this parameter to access hits beyond limit. Numbering starts at 1. limit param acts as page size. | ||
| // in:query | ||
| // required: false | ||
| Page int `json:"page"` | ||
| // Limit the number of returned results | ||
| // in:query | ||
| // required: false | ||
| Limit int `json:"limit"` | ||
| // From range for the query history search | ||
| // in:query | ||
| // required: false | ||
| From int64 `json:"from"` | ||
| // To range for the query history search | ||
| // in:query | ||
| // required: false | ||
| To int64 `json:"to"` | ||
| } | ||
|
|
||
| // swagger:parameters createQuery | ||
| type CreateQueryParams struct { | ||
| // in:body | ||
| // required:true | ||
| Body queryhistory.CreateQueryInQueryHistoryCommand `json:"body"` | ||
| } | ||
|
|
||
| // swagger:parameters patchQueryComment | ||
| type PatchQueryCommentParams struct { | ||
| // in:body | ||
| // required:true | ||
| Body queryhistory.PatchQueryCommentInQueryHistoryCommand `json:"body"` | ||
| } | ||
|
|
||
| // swagger:parameters migrateQueries | ||
| type MigrateQueriesParams struct { | ||
| // in:body | ||
| // required:true | ||
| Body queryhistory.MigrateQueriesToQueryHistoryCommand `json:"body"` | ||
| } | ||
|
|
||
| //swagger:response getQueryHistorySearchResponse | ||
| type GetQueryHistorySearchResponse struct { | ||
| // in: body | ||
| Body queryhistory.QueryHistorySearchResponse `json:"body"` | ||
| } | ||
|
|
||
| // swagger:response getQueryHistoryResponse | ||
| type GetQueryHistoryResponse struct { | ||
| // in: body | ||
| Body queryhistory.QueryHistoryResponse `json:"body"` | ||
| } | ||
|
|
||
| // swagger:response getQueryHistoryDeleteQueryResponse | ||
| type GetQueryHistoryDeleteQueryResponse struct { | ||
| // in: body | ||
| Body queryhistory.QueryHistoryDeleteQueryResponse `json:"body"` | ||
| } | ||
|
|
||
| // swagger:response getQueryHistoryMigrationResponse | ||
| type GetQueryHistoryMigrationResponse struct { | ||
| // in: body | ||
| Body queryhistory.QueryHistoryMigrationResponse `json:"body"` | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.