Swagger: Fix getLibraryElementByName response (#78221)

It returns an array of library elements, not a single one. This has been tested by generating the OpenAPI client and using it in Terraform
This commit is contained in:
Julien Duchesne 2023-12-04 11:20:13 -05:00 committed by GitHub
parent 3c51190392
commit cd584e9261
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 67 additions and 3 deletions

View File

@ -270,7 +270,7 @@ func (l *LibraryElementService) getConnectionsHandler(c *contextmodel.ReqContext
// Returns a library element with the given name.
//
// Responses:
// 200: getLibraryElementResponse
// 200: getLibraryElementArrayResponse
// 401: unauthorisedError
// 404: notFoundError
// 500: internalServerError
@ -448,6 +448,12 @@ type GetLibraryElementResponse struct {
Body model.LibraryElementResponse `json:"body"`
}
// swagger:response getLibraryElementArrayResponse
type GetLibraryElementArrayResponse struct {
// in: body
Body model.LibraryElementArrayResponse `json:"body"`
}
// swagger:response getLibraryElementConnectionsResponse
type GetLibraryElementConnectionsResponse struct {
// in: body

View File

@ -4764,6 +4764,18 @@
}
}
},
"LibraryElementArrayResponse": {
"type": "object",
"title": "LibraryElementArrayResponse is a response struct for an array of LibraryElementDTO.",
"properties": {
"result": {
"type": "array",
"items": {
"$ref": "#/definitions/LibraryElementDTO"
}
}
}
},
"LibraryElementConnectionDTO": {
"type": "object",
"title": "LibraryElementConnectionDTO is the frontend DTO for element connections.",
@ -8480,6 +8492,12 @@
"$ref": "#/definitions/GetHomeDashboardResponse"
}
},
"getLibraryElementArrayResponse": {
"description": "",
"schema": {
"$ref": "#/definitions/LibraryElementArrayResponse"
}
},
"getLibraryElementConnectionsResponse": {
"description": "",
"schema": {

View File

@ -6017,7 +6017,7 @@
],
"responses": {
"200": {
"$ref": "#/responses/getLibraryElementResponse"
"$ref": "#/responses/getLibraryElementArrayResponse"
},
"401": {
"$ref": "#/responses/unauthorisedError"
@ -15313,6 +15313,18 @@
}
}
},
"LibraryElementArrayResponse": {
"type": "object",
"title": "LibraryElementArrayResponse is a response struct for an array of LibraryElementDTO.",
"properties": {
"result": {
"type": "array",
"items": {
"$ref": "#/definitions/LibraryElementDTO"
}
}
}
},
"LibraryElementConnectionDTO": {
"type": "object",
"title": "LibraryElementConnectionDTO is the frontend DTO for element connections.",
@ -21654,6 +21666,12 @@
"$ref": "#/definitions/GetHomeDashboardResponse"
}
},
"getLibraryElementArrayResponse": {
"description": "(empty)",
"schema": {
"$ref": "#/definitions/LibraryElementArrayResponse"
}
},
"getLibraryElementConnectionsResponse": {
"description": "(empty)",
"schema": {

View File

@ -862,6 +862,16 @@
},
"description": "(empty)"
},
"getLibraryElementArrayResponse": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LibraryElementArrayResponse"
}
}
},
"description": "(empty)"
},
"getLibraryElementConnectionsResponse": {
"content": {
"application/json": {
@ -6321,6 +6331,18 @@
},
"type": "object"
},
"LibraryElementArrayResponse": {
"properties": {
"result": {
"items": {
"$ref": "#/components/schemas/LibraryElementDTO"
},
"type": "array"
}
},
"title": "LibraryElementArrayResponse is a response struct for an array of LibraryElementDTO.",
"type": "object"
},
"LibraryElementConnectionDTO": {
"properties": {
"connectionId": {
@ -18659,7 +18681,7 @@
],
"responses": {
"200": {
"$ref": "#/components/responses/getLibraryElementResponse"
"$ref": "#/components/responses/getLibraryElementArrayResponse"
},
"401": {
"$ref": "#/components/responses/unauthorisedError"