From 80065c47ab2d461b3a5e0afcc25277b65dd21d80 Mon Sep 17 00:00:00 2001 From: Josh Hunt Date: Fri, 30 Sep 2022 14:15:09 +0100 Subject: [PATCH] Chore: Updating swagger spec (#56094) --- public/api-merged.json | 50 ++++++++++++++++++++++++++++-------------- public/api-spec.json | 50 ++++++++++++++++++++++++++++-------------- public/openapi3.json | 50 ++++++++++++++++++++++++++++-------------- 3 files changed, 99 insertions(+), 51 deletions(-) diff --git a/public/api-merged.json b/public/api-merged.json index 64fff7bf107..1444b725093 100644 --- a/public/api-merged.json +++ b/public/api-merged.json @@ -8524,7 +8524,7 @@ "tags": [ "service_accounts" ], - "summary": "Create service account", + "summary": "# Create service account", "operationId": "createServiceAccount", "parameters": [ { @@ -8560,7 +8560,7 @@ "tags": [ "service_accounts" ], - "summary": "Search service accounts with paging", + "summary": "# Search service accounts with paging", "operationId": "searchOrgServiceAccountsWithPaging", "parameters": [ { @@ -8616,7 +8616,7 @@ "tags": [ "service_accounts" ], - "summary": "Get single serviceaccount by Id", + "summary": "# Get single serviceaccount by Id", "operationId": "retrieveServiceAccount", "parameters": [ { @@ -8653,7 +8653,7 @@ "tags": [ "service_accounts" ], - "summary": "Delete service account", + "summary": "# Delete service account", "operationId": "deleteServiceAccount", "parameters": [ { @@ -8687,7 +8687,7 @@ "tags": [ "service_accounts" ], - "summary": "Update service account", + "summary": "# Update service account", "operationId": "updateServiceAccount", "parameters": [ { @@ -8733,7 +8733,7 @@ "tags": [ "service_accounts" ], - "summary": "Get service account tokens", + "summary": "# Get service account tokens", "operationId": "listTokens", "parameters": [ { @@ -8767,7 +8767,7 @@ "tags": [ "service_accounts" ], - "summary": "CreateNewToken adds a token to a service account", + "summary": "# CreateNewToken adds a token to a service account", "operationId": "createToken", "parameters": [ { @@ -8816,7 +8816,7 @@ "tags": [ "service_accounts" ], - "summary": "DeleteToken deletes service account tokens", + "summary": "# DeleteToken deletes service account tokens", "operationId": "deleteToken", "parameters": [ { @@ -11430,8 +11430,7 @@ } }, "CorrelationConfigTarget": { - "description": "CorrelationConfigTarget is the target data query specific to target data source (Correlation.TargetUID)", - "type": "object" + "description": "CorrelationConfigTarget is the target data query specific to target data source (Correlation.TargetUID)" }, "CreateAlertNotificationCommand": { "type": "object", @@ -11659,7 +11658,7 @@ "items": { "type": "array", "items": { - "$ref": "#/definitions/PlaylistItemDTO" + "$ref": "#/definitions/PlaylistItem" } }, "name": { @@ -14908,22 +14907,27 @@ "type": "object", "properties": { "id": { + "description": "Unique playlist identifier for internal use, set by Grafana.", "type": "integer", "format": "int64" }, "interval": { + "description": "Interval sets the time between switching views in a playlist.\nFIXME: Is this based on a standardized format or what options are available? Can datemath be used?", "type": "string" }, "items": { + "description": "The ordered list of items that the playlist will iterate over.", "type": "array", "items": { - "$ref": "#/definitions/PlaylistItemDTO" + "$ref": "#/definitions/PlaylistItem" } }, "name": { + "description": "Name of the playlist.", "type": "string" }, "uid": { + "description": "Unique playlist identifier. Generated on creation, either by the\ncreator of the playlist of by the application.", "type": "string" } } @@ -14959,32 +14963,44 @@ "$ref": "#/definitions/PlaylistDashboard" } }, - "PlaylistItemDTO": { + "PlaylistItem": { + "description": "THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.\nEquivalent Go types at stable import paths are provided in https://github.com/grafana/grok.", "type": "object", + "title": "PlaylistItem is the Go representation of a playlist.Item.", "properties": { "id": { + "description": "FIXME: The prefixDropper removes playlist from playlist_id, that doesn't work for us since it'll mean we'll have Id twice.\nID of the playlist item for internal use by Grafana. Deprecated.", "type": "integer", "format": "int64" }, "order": { + "description": "Order is the position in the list for the item. Deprecated.", "type": "integer", "format": "int64" }, "playlistid": { + "description": "ID for the playlist containing the item. Deprecated.", "type": "integer", "format": "int64" }, "title": { + "description": "Title is the human-readable identifier for the playlist item.", "type": "string" }, "type": { - "type": "string" + "$ref": "#/definitions/PlaylistItemType" }, "value": { + "description": "Value depends on type and describes the playlist item.\n\ndashboard_by_id: The value is an internal numerical identifier set by Grafana. This\nis not portable as the numerical identifier is non-deterministic between different instances.\nWill be replaced by dashboard_by_uid in the future.\ndashboard_by_tag: The value is a tag which is set on any number of dashboards. All\ndashboards behind the tag will be added to the playlist.", "type": "string" } } }, + "PlaylistItemType": { + "description": "THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.\nEquivalent Go types at stable import paths are provided in https://github.com/grafana/grok.", + "type": "string", + "title": "Type of the item." + }, "Playlists": { "type": "array", "items": { @@ -17756,7 +17772,7 @@ "items": { "type": "array", "items": { - "$ref": "#/definitions/PlaylistItemDTO" + "$ref": "#/definitions/PlaylistItem" } }, "name": { @@ -19467,7 +19483,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/definitions/PlaylistItemDTO" + "$ref": "#/definitions/PlaylistItem" } } }, @@ -20126,4 +20142,4 @@ "name": "service_accounts" } ] -} +} \ No newline at end of file diff --git a/public/api-spec.json b/public/api-spec.json index 0e05977143c..3ea011c7b6f 100644 --- a/public/api-spec.json +++ b/public/api-spec.json @@ -7877,7 +7877,7 @@ "tags": [ "service_accounts" ], - "summary": "Create service account", + "summary": "# Create service account", "operationId": "createServiceAccount", "parameters": [ { @@ -7913,7 +7913,7 @@ "tags": [ "service_accounts" ], - "summary": "Search service accounts with paging", + "summary": "# Search service accounts with paging", "operationId": "searchOrgServiceAccountsWithPaging", "parameters": [ { @@ -7969,7 +7969,7 @@ "tags": [ "service_accounts" ], - "summary": "Get single serviceaccount by Id", + "summary": "# Get single serviceaccount by Id", "operationId": "retrieveServiceAccount", "parameters": [ { @@ -8006,7 +8006,7 @@ "tags": [ "service_accounts" ], - "summary": "Delete service account", + "summary": "# Delete service account", "operationId": "deleteServiceAccount", "parameters": [ { @@ -8040,7 +8040,7 @@ "tags": [ "service_accounts" ], - "summary": "Update service account", + "summary": "# Update service account", "operationId": "updateServiceAccount", "parameters": [ { @@ -8086,7 +8086,7 @@ "tags": [ "service_accounts" ], - "summary": "Get service account tokens", + "summary": "# Get service account tokens", "operationId": "listTokens", "parameters": [ { @@ -8120,7 +8120,7 @@ "tags": [ "service_accounts" ], - "summary": "CreateNewToken adds a token to a service account", + "summary": "# CreateNewToken adds a token to a service account", "operationId": "createToken", "parameters": [ { @@ -8169,7 +8169,7 @@ "tags": [ "service_accounts" ], - "summary": "DeleteToken deletes service account tokens", + "summary": "# DeleteToken deletes service account tokens", "operationId": "deleteToken", "parameters": [ { @@ -10450,8 +10450,7 @@ } }, "CorrelationConfigTarget": { - "description": "CorrelationConfigTarget is the target data query specific to target data source (Correlation.TargetUID)", - "type": "object" + "description": "CorrelationConfigTarget is the target data query specific to target data source (Correlation.TargetUID)" }, "CreateAlertNotificationCommand": { "type": "object", @@ -10679,7 +10678,7 @@ "items": { "type": "array", "items": { - "$ref": "#/definitions/PlaylistItemDTO" + "$ref": "#/definitions/PlaylistItem" } }, "name": { @@ -12825,22 +12824,27 @@ "type": "object", "properties": { "id": { + "description": "Unique playlist identifier for internal use, set by Grafana.", "type": "integer", "format": "int64" }, "interval": { + "description": "Interval sets the time between switching views in a playlist.\nFIXME: Is this based on a standardized format or what options are available? Can datemath be used?", "type": "string" }, "items": { + "description": "The ordered list of items that the playlist will iterate over.", "type": "array", "items": { - "$ref": "#/definitions/PlaylistItemDTO" + "$ref": "#/definitions/PlaylistItem" } }, "name": { + "description": "Name of the playlist.", "type": "string" }, "uid": { + "description": "Unique playlist identifier. Generated on creation, either by the\ncreator of the playlist of by the application.", "type": "string" } } @@ -12876,32 +12880,44 @@ "$ref": "#/definitions/PlaylistDashboard" } }, - "PlaylistItemDTO": { + "PlaylistItem": { + "description": "THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.\nEquivalent Go types at stable import paths are provided in https://github.com/grafana/grok.", "type": "object", + "title": "PlaylistItem is the Go representation of a playlist.Item.", "properties": { "id": { + "description": "FIXME: The prefixDropper removes playlist from playlist_id, that doesn't work for us since it'll mean we'll have Id twice.\nID of the playlist item for internal use by Grafana. Deprecated.", "type": "integer", "format": "int64" }, "order": { + "description": "Order is the position in the list for the item. Deprecated.", "type": "integer", "format": "int64" }, "playlistid": { + "description": "ID for the playlist containing the item. Deprecated.", "type": "integer", "format": "int64" }, "title": { + "description": "Title is the human-readable identifier for the playlist item.", "type": "string" }, "type": { - "type": "string" + "$ref": "#/definitions/PlaylistItemType" }, "value": { + "description": "Value depends on type and describes the playlist item.\n\ndashboard_by_id: The value is an internal numerical identifier set by Grafana. This\nis not portable as the numerical identifier is non-deterministic between different instances.\nWill be replaced by dashboard_by_uid in the future.\ndashboard_by_tag: The value is a tag which is set on any number of dashboards. All\ndashboards behind the tag will be added to the playlist.", "type": "string" } } }, + "PlaylistItemType": { + "description": "THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.\nEquivalent Go types at stable import paths are provided in https://github.com/grafana/grok.", + "type": "string", + "title": "Type of the item." + }, "Playlists": { "type": "array", "items": { @@ -14436,7 +14452,7 @@ "items": { "type": "array", "items": { - "$ref": "#/definitions/PlaylistItemDTO" + "$ref": "#/definitions/PlaylistItem" } }, "name": { @@ -15492,7 +15508,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/definitions/PlaylistItemDTO" + "$ref": "#/definitions/PlaylistItem" } } }, @@ -16151,4 +16167,4 @@ "name": "service_accounts" } ] -} +} \ No newline at end of file diff --git a/public/openapi3.json b/public/openapi3.json index aaa1a699e62..214224c03b7 100644 --- a/public/openapi3.json +++ b/public/openapi3.json @@ -942,7 +942,7 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/PlaylistItemDTO" + "$ref": "#/components/schemas/PlaylistItem" }, "type": "array" } @@ -2873,8 +2873,7 @@ "type": "object" }, "CorrelationConfigTarget": { - "description": "CorrelationConfigTarget is the target data query specific to target data source (Correlation.TargetUID)", - "type": "object" + "description": "CorrelationConfigTarget is the target data query specific to target data source (Correlation.TargetUID)" }, "CreateAlertNotificationCommand": { "properties": { @@ -3100,7 +3099,7 @@ }, "items": { "items": { - "$ref": "#/components/schemas/PlaylistItemDTO" + "$ref": "#/components/schemas/PlaylistItem" }, "type": "array" }, @@ -6349,22 +6348,27 @@ "PlaylistDTO": { "properties": { "id": { + "description": "Unique playlist identifier for internal use, set by Grafana.", "format": "int64", "type": "integer" }, "interval": { + "description": "Interval sets the time between switching views in a playlist.\nFIXME: Is this based on a standardized format or what options are available? Can datemath be used?", "type": "string" }, "items": { + "description": "The ordered list of items that the playlist will iterate over.", "items": { - "$ref": "#/components/schemas/PlaylistItemDTO" + "$ref": "#/components/schemas/PlaylistItem" }, "type": "array" }, "name": { + "description": "Name of the playlist.", "type": "string" }, "uid": { + "description": "Unique playlist identifier. Generated on creation, either by the\ncreator of the playlist of by the application.", "type": "string" } }, @@ -6401,32 +6405,44 @@ }, "type": "array" }, - "PlaylistItemDTO": { + "PlaylistItem": { + "description": "THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.\nEquivalent Go types at stable import paths are provided in https://github.com/grafana/grok.", "properties": { "id": { + "description": "FIXME: The prefixDropper removes playlist from playlist_id, that doesn't work for us since it'll mean we'll have Id twice.\nID of the playlist item for internal use by Grafana. Deprecated.", "format": "int64", "type": "integer" }, "order": { + "description": "Order is the position in the list for the item. Deprecated.", "format": "int64", "type": "integer" }, "playlistid": { + "description": "ID for the playlist containing the item. Deprecated.", "format": "int64", "type": "integer" }, "title": { + "description": "Title is the human-readable identifier for the playlist item.", "type": "string" }, "type": { - "type": "string" + "$ref": "#/components/schemas/PlaylistItemType" }, "value": { + "description": "Value depends on type and describes the playlist item.\n\ndashboard_by_id: The value is an internal numerical identifier set by Grafana. This\nis not portable as the numerical identifier is non-deterministic between different instances.\nWill be replaced by dashboard_by_uid in the future.\ndashboard_by_tag: The value is a tag which is set on any number of dashboards. All\ndashboards behind the tag will be added to the playlist.", "type": "string" } }, + "title": "PlaylistItem is the Go representation of a playlist.Item.", "type": "object" }, + "PlaylistItemType": { + "description": "THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.\nEquivalent Go types at stable import paths are provided in https://github.com/grafana/grok.", + "title": "Type of the item.", + "type": "string" + }, "Playlists": { "items": { "$ref": "#/components/schemas/Playlist" @@ -9195,7 +9211,7 @@ }, "items": { "items": { - "$ref": "#/components/schemas/PlaylistItemDTO" + "$ref": "#/components/schemas/PlaylistItem" }, "type": "array" }, @@ -19475,7 +19491,7 @@ "$ref": "#/components/responses/internalServerError" } }, - "summary": "Create service account", + "summary": "# Create service account", "tags": [ "service_accounts" ] @@ -19541,7 +19557,7 @@ "$ref": "#/components/responses/internalServerError" } }, - "summary": "Search service accounts with paging", + "summary": "# Search service accounts with paging", "tags": [ "service_accounts" ] @@ -19579,7 +19595,7 @@ "$ref": "#/components/responses/internalServerError" } }, - "summary": "Delete service account", + "summary": "# Delete service account", "tags": [ "service_accounts" ] @@ -19618,7 +19634,7 @@ "$ref": "#/components/responses/internalServerError" } }, - "summary": "Get single serviceaccount by Id", + "summary": "# Get single serviceaccount by Id", "tags": [ "service_accounts" ] @@ -19667,7 +19683,7 @@ "$ref": "#/components/responses/internalServerError" } }, - "summary": "Update service account", + "summary": "# Update service account", "tags": [ "service_accounts" ] @@ -19705,7 +19721,7 @@ "$ref": "#/components/responses/internalServerError" } }, - "summary": "Get service account tokens", + "summary": "# Get service account tokens", "tags": [ "service_accounts" ] @@ -19757,7 +19773,7 @@ "$ref": "#/components/responses/internalServerError" } }, - "summary": "CreateNewToken adds a token to a service account", + "summary": "# CreateNewToken adds a token to a service account", "tags": [ "service_accounts" ] @@ -19807,7 +19823,7 @@ "$ref": "#/components/responses/internalServerError" } }, - "summary": "DeleteToken deletes service account tokens", + "summary": "# DeleteToken deletes service account tokens", "tags": [ "service_accounts" ] @@ -21441,4 +21457,4 @@ "name": "service_accounts" } ] -} +} \ No newline at end of file