deprecate OrderResourceIdentifier

commercetools · Aug 7, 2023 · eeb1a65 · eeb1a65
1 parent 2a3afac
commit eeb1a65
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 35 deletions.
diff --git a/api-java-mixin.raml b/api-java-mixin.raml
@@ -257,18 +257,6 @@ types:
     (java-extends): 'com.commercetools.api.models.ResourcePagedQueryResponse<Order>'
   OrderReference:
     (java-extends): 'com.commercetools.api.models.Identifiable<Order>'
-  OrderResourceIdentifier:
-    (java-extends): 'com.commercetools.api.models.Identifiable<Order>'
-    (package): Order
-    type: ResourceIdentifier
-    (markDeprecated): true
-    displayName: OrderResourceIdentifier
-    discriminatorValue: order
-    properties:
-      id?:
-        type: string
-      key?:
-        type: string
   OrderUpdate:
     (java-extends): 'com.commercetools.api.models.ResourceUpdate<OrderUpdate, OrderUpdateAction, OrderUpdateBuilder>'
   OrderUpdateAction:

diff --git a/...s/commercetools-sdk-compat-v1/src/main/java/com/commercetools/compat/GetByKeyBuilder.java b/...s/commercetools-sdk-compat-v1/src/main/java/com/commercetools/compat/GetByKeyBuilder.java
@@ -298,13 +298,15 @@ public ByProjectKeyOrdersOrderNumberByOrderNumberGet order(final String key,
         return get(apiRoot.orders().withOrderNumber(key).get(), () -> OrderByOrderNumberGet.of(key), getDsl);
     }
 
+    @Deprecated
     public ByProjectKeyOrdersOrderNumberByOrderNumberGet order(final OrderResourceIdentifier identifiable,
             final Function<OrderByOrderNumberGet, OrderByOrderNumberGet> getDsl) {
         requireNonNull(identifiable.getKey());
         return get(apiRoot.orders().withOrderNumber(identifiable.getKey()).get(),
             () -> OrderByOrderNumberGet.of(identifiable.getKey()), getDsl);
     }
 
+    @Deprecated
     public ByProjectKeyOrdersOrderNumberByOrderNumberGet order(
             final io.sphere.sdk.models.ResourceIdentifiable<io.sphere.sdk.orders.Order> identifiable,
             final Function<OrderByOrderNumberGet, OrderByOrderNumberGet> getDsl) {

diff --git a/...ercetools-sdk-java-api/src/main/java/com/commercetools/api/models/ReferenceConverter.java b/...ercetools-sdk-java-api/src/main/java/com/commercetools/api/models/ReferenceConverter.java
@@ -120,6 +120,7 @@ static InventoryEntryResourceIdentifier toResourceIdentifier(InventoryEntryRefer
         return ResourceIdentifierBuilder.of().inventoryEntryBuilder().id(reference.getId()).build();
     }
 
+    @Deprecated
     static OrderResourceIdentifier toResourceIdentifier(OrderReference reference) {
         return ResourceIdentifierBuilder.of().orderBuilder().id(reference.getId()).build();
     }
@@ -212,6 +213,7 @@ static InventoryEntryResourceIdentifier toResourceIdentifier(InventoryEntry refe
         return ResourceIdentifierBuilder.of().inventoryEntryBuilder().id(reference.getId()).build();
     }
 
+    @Deprecated
     static OrderResourceIdentifier toResourceIdentifier(Order reference) {
         return ResourceIdentifierBuilder.of().orderBuilder().id(reference.getId()).build();
     }

diff --git a/...mmercetools-sdk-java-api/src/main/java/com/commercetools/api/models/order/OrderMixin.java b/...mmercetools-sdk-java-api/src/main/java/com/commercetools/api/models/order/OrderMixin.java
@@ -6,6 +6,7 @@
 
 public interface OrderMixin extends Referencable<Order>, ResourceIdentifiable<Order> {
     @Override
+    @Deprecated
     public default OrderResourceIdentifier toResourceIdentifier() {
         return OrderResourceIdentifier.builder().id(getId()).build();
     }

diff --git a/...models/order/OrderResourceIdentifier.java → ...models/order/OrderResourceIdentifier.java b/...models/order/OrderResourceIdentifier.java → ...models/order/OrderResourceIdentifier.java
@@ -1,18 +1,13 @@
 
 package com.commercetools.api.models.order;
 
-import java.time.*;
-import java.util.*;
-import java.util.function.Function;
-
-import javax.annotation.Nullable;
-
 import com.commercetools.api.models.common.ResourceIdentifier;
-import com.fasterxml.jackson.annotation.*;
-import com.fasterxml.jackson.databind.annotation.*;
-
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import io.vrap.rmf.base.client.utils.Generated;
 
+import javax.annotation.Nullable;
+import java.util.function.Function;
+
 /**
  * OrderResourceIdentifier
  *
@@ -26,6 +21,7 @@
  * </div>
  */
 @Generated(value = "io.vrap.rmf.codegen.rendering.CoreCodeGenerator", comments = "https://github.com/commercetools/rmf-codegen")
+@Deprecated
 @JsonDeserialize(as = OrderResourceIdentifierImpl.class)
 public interface OrderResourceIdentifier extends ResourceIdentifier, com.commercetools.api.models.Identifiable<Order> {
 

diff --git a/...order/OrderResourceIdentifierBuilder.java → ...order/OrderResourceIdentifierBuilder.java b/...order/OrderResourceIdentifierBuilder.java → ...order/OrderResourceIdentifierBuilder.java
@@ -1,13 +1,11 @@
 
 package com.commercetools.api.models.order;
 
-import java.util.*;
-
-import javax.annotation.Nullable;
-
 import io.vrap.rmf.base.client.Builder;
 import io.vrap.rmf.base.client.utils.Generated;
 
+import javax.annotation.Nullable;
+
 /**
  * OrderResourceIdentifierBuilder
  * <hr>
@@ -20,6 +18,7 @@
  * </div>
  */
 @Generated(value = "io.vrap.rmf.codegen.rendering.CoreCodeGenerator", comments = "https://github.com/commercetools/rmf-codegen")
+@Deprecated
 public class OrderResourceIdentifierBuilder implements Builder<OrderResourceIdentifier> {
 
     @Nullable

diff --git a/...ls/order/OrderResourceIdentifierImpl.java → ...ls/order/OrderResourceIdentifierImpl.java b/...ls/order/OrderResourceIdentifierImpl.java → ...ls/order/OrderResourceIdentifierImpl.java
@@ -1,27 +1,22 @@
 
 package com.commercetools.api.models.order;
 
-import java.time.*;
-import java.util.*;
-
 import com.commercetools.api.models.common.ReferenceTypeId;
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
-import com.fasterxml.jackson.databind.annotation.*;
-
 import io.vrap.rmf.base.client.ModelBase;
 import io.vrap.rmf.base.client.utils.Generated;
-
 import org.apache.commons.lang3.builder.EqualsBuilder;
 import org.apache.commons.lang3.builder.HashCodeBuilder;
 
 /**
  * OrderResourceIdentifier
  */
 @Generated(value = "io.vrap.rmf.codegen.rendering.CoreCodeGenerator", comments = "https://github.com/commercetools/rmf-codegen")
+@Deprecated
 public class OrderResourceIdentifierImpl implements OrderResourceIdentifier, ModelBase {
 
-    private com.commercetools.api.models.common.ReferenceTypeId typeId;
+    private ReferenceTypeId typeId;
 
     private String id;
 
@@ -48,7 +43,7 @@ public OrderResourceIdentifierImpl() {
      *  <p>Type of referenced resource. If given, it must match the expected ReferenceTypeId of the referenced resource.</p>
      */
 
-    public com.commercetools.api.models.common.ReferenceTypeId getTypeId() {
+    public ReferenceTypeId getTypeId() {
         return this.typeId;
     }
 

diff --git a/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/HelperMethods.java b/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/HelperMethods.java
@@ -287,8 +287,6 @@
  *
  * <h2>Orders</h2>
  *
- * <p>{@link com.commercetools.api.models.order.Order#toResourceIdentifier()}</p>
- * {@include.example example.HelperMethodsTest#orderToResourceIdentifier()}
  * <p>{@link com.commercetools.api.models.order.Order#toReference()}</p>
  * {@include.example example.HelperMethodsTest#orderToReference()}
  * <p>{@link com.commercetools.api.models.order.Order#referenceTypeId()}</p>