From 23567fa3dd3309b1fd2ee3f4bd18979a5fb02fca Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marc=20Busqu=C3=A9?= <marc@lamarciana.com>
Date: Wed, 1 Jun 2022 10:56:11 +0200
Subject: [PATCH] Make API docs deprecation warnings consistent

On efe4becfd66c06621a9d613edc3d77bdc350a3c4,
7c49645dd9098722524767323e82441b326e9a4b &
3dcc3fae3075fff18f3bb216e2a9a29e3a42e128 we added deprecation notices to
the API documentation.

However, in 6b8004bb525cae937d50b8a047336a22c063664f, a better way, with
actual links to the recommended routes, was used.

We update the formers to use actual links and a message format
consistent with the latter.
---
 api/openapi/solidus-api.oas.yml | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/api/openapi/solidus-api.oas.yml b/api/openapi/solidus-api.oas.yml
index 03b61193e70..7f30147873a 100644
--- a/api/openapi/solidus-api.oas.yml
+++ b/api/openapi/solidus-api.oas.yml
@@ -683,7 +683,7 @@ paths:
           $ref: '#/components/responses/not-found'
       summary: Get product variant
       description: |-
-        **DEPRECATED**: Use *GET /variants/{id}* instead
+        **Deprecation Warning**: Use [shallow version](/docs/solidus/87df124706c5f-get-variant) instead
 
         Retrieves a product's variant.
       operationId: get-product-variant
@@ -718,7 +718,7 @@ paths:
           $ref: '#/components/responses/delete-restriction'
       summary: Delete product variant
       description: |-
-        **DEPRECATED**: Use *DELETE /variants/{id}* instead
+        **Deprecation Warning**: Use [shallow version](/docs/solidus/82ccaada99139-delete-variant) instead
 
         Deletes a product's variant.
       operationId: delete-product-variant
@@ -742,7 +742,7 @@ paths:
           $ref: '#/components/responses/unprocessable-entity'
       summary: Update product variant
       description: |-
-        **DEPRECATED**: Use *PUT /variants/{id}* instead
+        **Deprecation Warning**: Use [shallow version](/docs/solidus/ce338b5f3b940-update-variant) instead
 
         Updates a product's variant.
       operationId: update-product-variant
@@ -867,7 +867,7 @@ paths:
           $ref: '#/components/responses/unprocessable-entity'
       summary: Create variant
       description: |-
-        **DEPRECATED**: Use *POST /products/{product_id}/variants* instead
+        **Deprecation Warning**: Use [nested version](/docs/solidus/681aa6cb75b1e-create-product-variant) instead
 
         Creates a variant. Only users with `can :create, Variant` permissions can perform this action.
       operationId: create-variant
@@ -2556,7 +2556,7 @@ paths:
           $ref: '#/components/responses/unprocessable-entity'
       summary: Create option value
       description: |-
-        **DEPRECATED**: Use *POST /option_types/{option_type_id}/option_values* instead
+        **Deprecation Warning**: Use [nested version](/docs/solidus/810154673c613-create-option-type-value) instead
 
         Creates an option value.
 
@@ -2730,7 +2730,7 @@ paths:
           $ref: '#/components/responses/not-found'
       summary: Get option type value
       description: |-
-        **DEPRECATED**: Use *GET /option_values/{id}* instead
+        **Deprecation Warning**: Use [shallow version](/docs/solidus/cbbc403ed08a3-get-option-value) instead
 
         Retrieves an option type's value.
       operationId: get-option-type-value
@@ -2767,7 +2767,7 @@ paths:
           $ref: '#/components/responses/delete-restriction'
       summary: Delete option type value
       description: |-
-        **DEPRECATED**: Use *DELETE /option_values/{id}* instead
+        **Deprecation Warning**: Use [shallow version](/docs/solidus/0742e63219b1f-delete-option-value) instead
 
         Deletes an option type's value.
       operationId: delete-option-type-value
@@ -2791,7 +2791,7 @@ paths:
           $ref: '#/components/responses/unprocessable-entity'
       summary: Update option type value
       description: |-
-        **DEPRECATED**: Use *PATCH /option_values/{id}* instead
+        **Deprecation Warning**: Use [shallow version](/docs/solidus/b43f889175ebb-update-option-value) instead
 
         Updates an option type's value.