opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-29 19:52:35 +08:00
Code Issues Packages Projects Releases Wiki Activity

API: Make Swagger specification more consistent (#50576)

Browse Source 
* Fix swagger generation targer using mac

Validate using the swagger binarry instead of the docker container

* API: Make swagger specification more consistent

Fix operation parameter ordering
This commit is contained in:
Sofia Papagiannaki
2022-06-14 13:35:22 +03:00
committed by GitHub
parent f87927c82e
commit 7418a80264
24 changed files with 1674 additions and 399 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
pkg/api/docs/definitions/annotations.go
View File

@ -113,8 +113,15 @@ import (
// 401: unauthorisedError
// 500: internalServerError
// swagger:parameters getAnnotation updateAnnotation patchAnnotation deleteAnnotation
type AnnotationIDParam struct {
// swagger:parameters getAnnotation
type GetAnnotationParams struct {
// in:path
// required:true
AnnotationID string `json:"annotation_id"`
}
// swagger:parameters deleteAnnotation
type DeleteAnnotationParams struct {
// in:path
// required:true
AnnotationID string `json:"annotation_id"`
@ -206,6 +213,9 @@ type CreateGraphiteAnnotationParams struct {
// swagger:parameters updateAnnotation
type UpdateAnnotationParams struct {
// in:path
// required:true
AnnotationID string `json:"annotation_id"`
// in:body
// required:true
Body dtos.UpdateAnnotationsCmd `json:"body"`
@ -213,6 +223,9 @@ type UpdateAnnotationParams struct {
// swagger:parameters patchAnnotation
type PatchAnnotationParams struct {
// in:path
// required:true
AnnotationID string `json:"annotation_id"`
// in:body
// required:true
Body dtos.PatchAnnotationsCmd `json:"body"`