API: Add add deprecation notice for getting folder by sequential ID (#67091)

* API: Add deprecation notice

* Update Swagger/openAPI
This commit is contained in:
Sofia Papagiannaki
2023-04-25 10:33:47 +03:00
committed by GitHub
parent 1324434dfb
commit 3bc002cd27
3 changed files with 8 additions and 9 deletions

View File

@ -96,7 +96,10 @@ func (hs *HTTPServer) GetFolderByUID(c *contextmodel.ReqContext) response.Respon
// //
// Get folder by id. // Get folder by id.
// //
// Returns the folder identified by id. // Returns the folder identified by id. This is deprecated.
// Please refer to [updated API](#/folders/getFolderByUID) instead
//
// Deprecated: true
// //
// Responses: // Responses:
// 200: folderResponse // 200: folderResponse

View File

@ -5490,12 +5490,13 @@
}, },
"/folders/id/{folder_id}": { "/folders/id/{folder_id}": {
"get": { "get": {
"description": "Returns the folder identified by id.", "description": "Returns the folder identified by id. This is deprecated.\nPlease refer to [updated API](#/folders/getFolderByUID) instead",
"tags": [ "tags": [
"folders" "folders"
], ],
"summary": "Get folder by id.", "summary": "Get folder by id.",
"operationId": "getFolderByID", "operationId": "getFolderByID",
"deprecated": true,
"parameters": [ "parameters": [
{ {
"type": "integer", "type": "integer",
@ -13596,9 +13597,6 @@
"FolderSearchHit": { "FolderSearchHit": {
"type": "object", "type": "object",
"properties": { "properties": {
"accessControl": {
"$ref": "#/definitions/Metadata"
},
"id": { "id": {
"type": "integer", "type": "integer",
"format": "int64" "format": "int64"

View File

@ -4663,9 +4663,6 @@
}, },
"FolderSearchHit": { "FolderSearchHit": {
"properties": { "properties": {
"accessControl": {
"$ref": "#/components/schemas/Metadata"
},
"id": { "id": {
"format": "int64", "format": "int64",
"type": "integer" "type": "integer"
@ -16848,7 +16845,8 @@
}, },
"/folders/id/{folder_id}": { "/folders/id/{folder_id}": {
"get": { "get": {
"description": "Returns the folder identified by id.", "deprecated": true,
"description": "Returns the folder identified by id. This is deprecated.\nPlease refer to [updated API](#/folders/getFolderByUID) instead",
"operationId": "getFolderByID", "operationId": "getFolderByID",
"parameters": [ "parameters": [
{ {