docs(openapi): name replacements for deprecated operations

docs/api/openapi.yml

@@ -14283,8 +14283,9 @@ paths:
   /api/v1/cloud-integrations/{cloud_provider}/agent-check-in:
     post:
       deprecated: true
-      description: '[Deprecated] This endpoint is called by the deployed agent to
-        check in'
+      description: 'This endpoint is called by the deployed agent to check in. Deprecated:
+        use POST /api/v1/cloud_integrations/{cloud_provider}/accounts/check_in instead.
+        Send cloudIntegrationId and providerAccountId instead of account_id and cloud_account_id.'
       operationId: AgentCheckInDeprecated
       parameters:
       - in: path
@@ -18952,7 +18953,7 @@ paths:
   /api/v1/testChannel:
     post:
       deprecated: true
-      description: 'Deprecated: use /api/v1/channels/test instead'
+      description: 'Deprecated: use POST /api/v1/channels/test instead.'
       operationId: TestChannelDeprecated
       requestBody:
         content:
@@ -21439,7 +21440,8 @@ paths:
       x-signoz-stability: alpha
     post:
       deprecated: true
-      description: This endpoint creates an ingestion key limit.
+      description: 'This endpoint creates an ingestion key limit. Deprecated: use
+        POST /api/v2/gateway/ingestion_limits instead. Send keyId in the request body.'
       operationId: CreateIngestionKeyLimit
       parameters:
       - in: path
@@ -21499,7 +21501,8 @@ paths:
   /api/v2/gateway/ingestion_keys/limits/{limitId}:
     delete:
       deprecated: true
-      description: This endpoint deletes an ingestion key limit
+      description: 'This endpoint deletes an ingestion key limit. Deprecated: use
+        DELETE /api/v2/gateway/ingestion_limits/{limitId} instead.'
       operationId: DeleteIngestionKeyLimit
       parameters:
       - in: path
@@ -21541,7 +21544,8 @@ paths:
       x-signoz-stability: alpha
     patch:
       deprecated: true
-      description: This endpoint updates an ingestion key limit.
+      description: 'This endpoint updates an ingestion key limit. Deprecated: use
+        PATCH /api/v2/gateway/ingestion_limits/{limitId} instead.'
       operationId: UpdateIngestionKeyLimit
       parameters:
       - in: path
@@ -25531,8 +25535,8 @@ paths:
     get:
       deprecated: true
       description: 'This endpoint lists all alert rules with their current evaluation
-        state. Deprecated: use ListRulesV3, which supports filtering, sorting and
-        pagination.'
+        state. Deprecated: use GET /api/v3/rules instead, which supports filtering,
+        sorting and pagination.'
       operationId: ListRules
       responses:
         "200":
@@ -31709,8 +31713,9 @@ paths:
   /api/v3/licenses:
     post:
       deprecated: true
-      description: This endpoint validates the license key with the upstream server
-        and activates the license for the organization.
+      description: 'This endpoint validates the license key with the upstream server
+        and activates the license for the organization. Deprecated: use POST /api/v4/licenses
+        instead. The v4 endpoint returns 201 with the license id.'
       operationId: ActivateLicenseDeprecated
       requestBody:
         content:
@@ -31767,8 +31772,9 @@ paths:
       x-signoz-stability: alpha
     put:
       deprecated: true
-      description: This endpoint refreshes the active license of the organization
-        from the upstream server.
+      description: 'This endpoint refreshes the active license of the organization
+        from the upstream server. Deprecated: use PUT /api/v4/licenses/{id} instead.
+        Pass the active license id in the path.'
       operationId: RefreshLicenseDeprecated
       responses:
         "204":
@@ -32307,8 +32313,8 @@ paths:
       x-signoz-stability: alpha
     put:
       deprecated: false
-      description: This endpoint refreshes the active license of the organization
-        from the upstream server.
+      description: This endpoint refreshes the license with the given id from the
+        upstream server. Only the active license can be refreshed.
       operationId: RefreshLicense
       parameters:
       - in: path

frontend/src/api/generated/services/channels/index.ts

@@ -597,7 +597,7 @@ export const useTestChannel = <
 	return useMutation(getTestChannelMutationOptions(options));
 };
 /**
- * Deprecated: use /api/v1/channels/test instead
+ * Deprecated: use POST /api/v1/channels/test instead.
  * @deprecated
  * @summary Test notification channel (deprecated)
  */

frontend/src/api/generated/services/cloudintegration/index.ts

@@ -72,7 +72,7 @@ const withQueryKey = <T extends object, K>(
 };
 
 /**
- * [Deprecated] This endpoint is called by the deployed agent to check in
+ * This endpoint is called by the deployed agent to check in. Deprecated: use POST /api/v1/cloud_integrations/{cloud_provider}/accounts/check_in instead. Send cloudIntegrationId and providerAccountId instead of account_id and cloud_account_id.
  * @deprecated
  * @summary Agent check-in
  */

frontend/src/api/generated/services/gateway/index.ts

@@ -634,7 +634,7 @@ export const invalidateGetIngestionKeyLimits = async (
 };
 
 /**
- * This endpoint creates an ingestion key limit.
+ * This endpoint creates an ingestion key limit. Deprecated: use POST /api/v2/gateway/ingestion_limits instead. Send keyId in the request body.
  * @deprecated
  * @summary Create limit for the ingestion key
  */
@@ -736,7 +736,7 @@ export const useCreateIngestionKeyLimit = <
 	return useMutation(getCreateIngestionKeyLimitMutationOptions(options));
 };
 /**
- * This endpoint deletes an ingestion key limit
+ * This endpoint deletes an ingestion key limit. Deprecated: use DELETE /api/v2/gateway/ingestion_limits/{limitId} instead.
  * @deprecated
  * @summary Delete limit for the ingestion key
  */
@@ -818,7 +818,7 @@ export const useDeleteIngestionKeyLimit = <
 	return useMutation(getDeleteIngestionKeyLimitMutationOptions(options));
 };
 /**
- * This endpoint updates an ingestion key limit.
+ * This endpoint updates an ingestion key limit. Deprecated: use PATCH /api/v2/gateway/ingestion_limits/{limitId} instead.
  * @deprecated
  * @summary Update limit for the ingestion key
  */

frontend/src/api/generated/services/licenses/index.ts

@@ -53,7 +53,7 @@ const withQueryKey = <T extends object, K>(
 };
 
 /**
- * This endpoint validates the license key with the upstream server and activates the license for the organization.
+ * This endpoint validates the license key with the upstream server and activates the license for the organization. Deprecated: use POST /api/v4/licenses instead. The v4 endpoint returns 201 with the license id.
  * @deprecated
  * @summary Activate a license.
  */
@@ -139,7 +139,7 @@ export const useActivateLicenseDeprecated = <
 	return useMutation(getActivateLicenseDeprecatedMutationOptions(options));
 };
 /**
- * This endpoint refreshes the active license of the organization from the upstream server.
+ * This endpoint refreshes the active license of the organization from the upstream server. Deprecated: use PUT /api/v4/licenses/{id} instead. Pass the active license id in the path.
  * @deprecated
  * @summary Refresh a license.
  */
@@ -559,7 +559,7 @@ export const invalidateGetLicense = async (
 };
 
 /**
- * This endpoint refreshes the active license of the organization from the upstream server.
+ * This endpoint refreshes the license with the given id from the upstream server. Only the active license can be refreshed.
  * @summary Refresh a license.
  */
 export const refreshLicense = (

frontend/src/api/generated/services/rules/index.ts

@@ -428,7 +428,7 @@ export const useUpdateRuleView = <
 	return useMutation(getUpdateRuleViewMutationOptions(options));
 };
 /**
- * This endpoint lists all alert rules with their current evaluation state. Deprecated: use ListRulesV3, which supports filtering, sorting and pagination.
+ * This endpoint lists all alert rules with their current evaluation state. Deprecated: use GET /api/v3/rules instead, which supports filtering, sorting and pagination.
  * @deprecated
  * @summary List alert rules
  */

pkg/apiserver/signozapiserver/alertmanager.go

@@ -119,7 +119,7 @@ func (provider *provider) addAlertmanagerRoutes(router *mux.Router) error {
 		ID:                  "TestChannelDeprecated",
 		Tags:                []string{"channels"},
 		Summary:             "Test notification channel (deprecated)",
-		Description:         "Deprecated: use /api/v1/channels/test instead",
+		Description:         "Deprecated: use POST /api/v1/channels/test instead.",
 		Request:             new(alertmanagertypes.Receiver),
 		RequestContentType:  "application/json",
 		Response:            nil,

pkg/apiserver/signozapiserver/cloudintegration.go

@@ -336,7 +336,7 @@ func (provider *provider) addCloudIntegrationRoutes(router *mux.Router) error {
 			ID:                  "AgentCheckInDeprecated",
 			Tags:                []string{"cloudintegration"},
 			Summary:             "Agent check-in",
-			Description:         "[Deprecated] This endpoint is called by the deployed agent to check in",
+			Description:         "This endpoint is called by the deployed agent to check in. Deprecated: use POST /api/v1/cloud_integrations/{cloud_provider}/accounts/check_in instead. Send cloudIntegrationId and providerAccountId instead of account_id and cloud_account_id.",
 			Request:             new(citypes.PostableAgentCheckIn),
 			RequestContentType:  "application/json",
 			Response:            new(citypes.GettableAgentCheckIn),

pkg/apiserver/signozapiserver/gateway.go

@@ -207,7 +207,7 @@ func (provider *provider) addGatewayRoutes(router *mux.Router) error {
 			ID:                  "CreateIngestionKeyLimit",
 			Tags:                []string{"gateway"},
 			Summary:             "Create limit for the ingestion key",
-			Description:         "This endpoint creates an ingestion key limit.",
+			Description:         "This endpoint creates an ingestion key limit. Deprecated: use POST /api/v2/gateway/ingestion_limits instead. Send keyId in the request body.",
 			Request:             new(gatewaytypes.DeprecatedPostableIngestionKeyLimit),
 			RequestContentType:  "application/json",
 			Response:            new(gatewaytypes.GettableCreatedIngestionKeyLimit),
@@ -245,7 +245,7 @@ func (provider *provider) addGatewayRoutes(router *mux.Router) error {
 			ID:                  "UpdateIngestionKeyLimit",
 			Tags:                []string{"gateway"},
 			Summary:             "Update limit for the ingestion key",
-			Description:         "This endpoint updates an ingestion key limit.",
+			Description:         "This endpoint updates an ingestion key limit. Deprecated: use PATCH /api/v2/gateway/ingestion_limits/{limitId} instead.",
 			Request:             new(gatewaytypes.UpdatableIngestionKeyLimit),
 			RequestContentType:  "application/json",
 			Response:            nil,
@@ -272,7 +272,7 @@ func (provider *provider) addGatewayRoutes(router *mux.Router) error {
 			ID:                  "DeleteIngestionKeyLimit",
 			Tags:                []string{"gateway"},
 			Summary:             "Delete limit for the ingestion key",
-			Description:         "This endpoint deletes an ingestion key limit",
+			Description:         "This endpoint deletes an ingestion key limit. Deprecated: use DELETE /api/v2/gateway/ingestion_limits/{limitId} instead.",
 			Request:             nil,
 			RequestContentType:  "application/json",
 			Response:            nil,

pkg/apiserver/signozapiserver/licensing.go

@@ -45,7 +45,7 @@ func (provider *provider) addLicensingRoutes(router *mux.Router) error {
 			ID:                  "ActivateLicenseDeprecated",
 			Tags:                []string{"licenses"},
 			Summary:             "Activate a license.",
-			Description:         "This endpoint validates the license key with the upstream server and activates the license for the organization.",
+			Description:         "This endpoint validates the license key with the upstream server and activates the license for the organization. Deprecated: use POST /api/v4/licenses instead. The v4 endpoint returns 201 with the license id.",
 			Request:             new(licensetypes.PostableLicense),
 			RequestContentType:  "application/json",
 			Response:            nil,
@@ -71,7 +71,7 @@ func (provider *provider) addLicensingRoutes(router *mux.Router) error {
 			ID:                  "RefreshLicenseDeprecated",
 			Tags:                []string{"licenses"},
 			Summary:             "Refresh a license.",
-			Description:         "This endpoint refreshes the active license of the organization from the upstream server.",
+			Description:         "This endpoint refreshes the active license of the organization from the upstream server. Deprecated: use PUT /api/v4/licenses/{id} instead. Pass the active license id in the path.",
 			Request:             nil,
 			RequestContentType:  "",
 			Response:            nil,
@@ -167,7 +167,7 @@ func (provider *provider) addLicensingRoutes(router *mux.Router) error {
 			ID:                  "RefreshLicense",
 			Tags:                []string{"licenses"},
 			Summary:             "Refresh a license.",
-			Description:         "This endpoint refreshes the active license of the organization from the upstream server.",
+			Description:         "This endpoint refreshes the license with the given id from the upstream server. Only the active license can be refreshed.",
 			Request:             nil,
 			RequestContentType:  "",
 			Response:            nil,

pkg/apiserver/signozapiserver/ruler.go

@@ -18,7 +18,7 @@ func (provider *provider) addRulerRoutes(router *mux.Router) error {
 		ID:                  "ListRules",
 		Tags:                []string{"rules"},
 		Summary:             "List alert rules",
-		Description:         "This endpoint lists all alert rules with their current evaluation state. Deprecated: use ListRulesV3, which supports filtering, sorting and pagination.",
+		Description:         "This endpoint lists all alert rules with their current evaluation state. Deprecated: use GET /api/v3/rules instead, which supports filtering, sorting and pagination.",
 		Response:            make([]*ruletypes.Rule, 0),
 		ResponseContentType: "application/json",
 		SuccessStatusCode:   http.StatusOK,