Better deprecation notices (#19)

openactive · Mar 2, 2021 · e00e020 · e00e020
1 parent a24dcb5
commit e00e020
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 7 deletions.
diff --git a/OpenActive.NET.Generator/package-lock.json b/OpenActive.NET.Generator/package-lock.json
diff --git a/OpenActive.NET.Generator/package.json b/OpenActive.NET.Generator/package.json
@@ -11,7 +11,7 @@
   "author": "Nick Evans",
   "license": "MIT",
   "dependencies": {
-    "@openactive/data-models": "^2.0.179",
+    "@openactive/data-models": "^2.0.180",
     "fs-extra": "^7.0.1",
     "sync-request": "^6.0.0"
   }

diff --git a/OpenActive.NET/models/Offer.cs b/OpenActive.NET/models/Offer.cs
@@ -116,11 +116,12 @@ public override string ToString()
 
 
         /// <summary>
-        /// DEPRECATED: Please use `oa:ageRestriction` instead when describing an `Offer`. 
+        /// [DEPRECATED: Use `ageRestriction` instead of `ageRange` within the `Offer` for cases where the `Offer` is age restricted.]
         /// Indicates that an Offer is only applicable to a specific age range.
         /// </summary>
         [DataMember(Name = "ageRange", EmitDefaultValue = false, Order = 12)]
         [JsonConverter(typeof(ValuesConverter))]
+        [Obsolete("Use `ageRestriction` instead of `ageRange` within the `Offer` for cases where the `Offer` is age restricted.", false)]
         public virtual QuantitativeValue AgeRange { get; set; }
 
 

diff --git a/OpenActive.NET/models/PartialSchedule.cs b/OpenActive.NET/models/PartialSchedule.cs
@@ -56,13 +56,14 @@ public override string ToString()
 
 
         /// <summary>
-        /// [NOTICE: This is a beta property, and is highly likely to change in future versions of this library.]
+        /// [DEPRECATED: This term has graduated from the beta namespace and is highly likely to be removed in future versions of this library, please use `scheduleTimezone` instead.]
         /// The time zone used to generate occurrences, same as iCal TZID. E.g. 'Europe/London'.
         /// 
         /// If you are using this property, please join the discussion at proposal [#197](https://github.com/openactive/modelling-opportunity-data/issues/197).
         /// </summary>
         [DataMember(Name = "beta:timeZone", EmitDefaultValue = false, Order = 1009)]
         [JsonConverter(typeof(ValuesConverter))]
+        [Obsolete("This term has graduated from the beta namespace and is highly likely to be removed in future versions of this library, please use `scheduleTimezone` instead.", false)]
         public override string TimeZone { get; set; }
 
     }

diff --git a/OpenActive.NET/models/Schedule.cs b/OpenActive.NET/models/Schedule.cs
@@ -257,13 +257,14 @@ public override string ToString()
 
 
         /// <summary>
-        /// [NOTICE: This is a beta property, and is highly likely to change in future versions of this library.]
+        /// [DEPRECATED: This term has graduated from the beta namespace and is highly likely to be removed in future versions of this library, please use `scheduleTimezone` instead.]
         /// The time zone used to generate occurrences, same as iCal TZID. E.g. 'Europe/London'.
         /// 
         /// If you are using this property, please join the discussion at proposal [#197](https://github.com/openactive/modelling-opportunity-data/issues/197).
         /// </summary>
         [DataMember(Name = "beta:timeZone", EmitDefaultValue = false, Order = 1022)]
         [JsonConverter(typeof(ValuesConverter))]
+        [Obsolete("This term has graduated from the beta namespace and is highly likely to be removed in future versions of this library, please use `scheduleTimezone` instead.", false)]
         public virtual string TimeZone { get; set; }
 
     }