Added @specifiedBy to LocalDate scalar (#8868)

glen-84 · web-flow · commit 00e1c5fae298 · 2025-11-04T16:45:28.000+02:00
diff --git a/src/HotChocolate/Core/src/Types/Properties/TypeResources.Designer.cs b/src/HotChocolate/Core/src/Types/Properties/TypeResources.Designer.cs
diff --git a/src/HotChocolate/Core/src/Types/Properties/TypeResources.resx b/src/HotChocolate/Core/src/Types/Properties/TypeResources.resx
@@ -49,7 +49,7 @@
     <value>Unable to register a DataLoader with your DataLoader registry.</value>
   </data>
   <data name="DateTimeType_Description" xml:space="preserve">
-    <value>The `DateTime` scalar represents an ISO-8601 compliant date time type.</value>
+    <value>The `DateTime` scalar represents an exact point in time. This point in time is specified by having an offset to UTC and does not use a time zone.</value>
   </data>
   <data name="DateType_Description" xml:space="preserve">
     <value>The `Date` scalar represents an ISO-8601 compliant date type.</value>
@@ -982,7 +982,7 @@ Type: `{0}`</value>
     <value>The `LocalDateTime` scalar type is a local date/time string (i.e., with no associated timezone) with the format `YYYY-MM-DDThh:mm:ss`.</value>
   </data>
   <data name="LocalDateType_Description" xml:space="preserve">
-    <value>The `LocalDate` scalar type represents an ISO date string, represented as UTF-8 character sequences YYYY-MM-DD. The scalar follows the specification defined in RFC3339</value>
+    <value>The `LocalDate` scalar represents a date without a time-zone in the ISO-8601 calendar system.</value>
   </data>
   <data name="LocalTimeType_Description" xml:space="preserve">
     <value>The LocalTime scalar type is a local time string (i.e., with no associated timezone) in 24-hr HH:mm:ss.</value>
diff --git a/src/HotChocolate/Core/src/Types/Types/Scalars/DateTimeType.cs b/src/HotChocolate/Core/src/Types/Types/Scalars/DateTimeType.cs
@@ -7,8 +7,15 @@
 namespace HotChocolate.Types;
 
 /// <summary>
-/// This GraphQL Scalar represents an exact point in time.
-/// This point in time is specified by having an offset to UTC and does not use time zone.
+/// <para>
+/// This scalar represents an exact point in time. This point in time is specified by having an
+/// offset to UTC and does <b>not</b> use a time zone.
+/// </para>
+/// <para>
+/// It is a slightly refined version of
+/// <see href="https://tools.ietf.org/html/rfc3339">RFC 3339</see>, including the
+/// <see href="https://www.rfc-editor.org/errata/rfc3339">errata</see>.
+/// </para>
 /// </summary>
 /// <seealso href="https://scalars.graphql.org/andimarek/date-time.html">Specification</seealso>
 public class DateTimeType : ScalarType<DateTimeOffset, StringValueNode>
diff --git a/src/HotChocolate/Core/src/Types/Types/Scalars/LocalDateType.cs b/src/HotChocolate/Core/src/Types/Types/Scalars/LocalDateType.cs
@@ -6,13 +6,19 @@
 namespace HotChocolate.Types;
 
 /// <summary>
-/// The `LocalDate` scalar type represents an ISO date string, represented as UTF-8
-/// character sequences YYYY-MM-DD. The scalar follows the specification defined in
-/// <a href="https://tools.ietf.org/html/rfc3339">RFC3339</a>
+/// <para>
+/// This scalar represents a date without a time-zone in the
+/// <see href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601</see> calendar system.
+/// </para>
+/// <para>
+/// The pattern is "YYYY-MM-DD" with "YYYY" representing the year, "MM" the month, and "DD" the day.
+/// </para>
 /// </summary>
+/// <seealso href="https://scalars.graphql.org/andimarek/local-date.html">Specification</seealso>
 public class LocalDateType : ScalarType<DateOnly, StringValueNode>
 {
     private const string LocalFormat = "yyyy-MM-dd";
+    private const string SpecifiedByUri = "https://scalars.graphql.org/andimarek/local-date.html";
     private readonly bool _enforceSpecFormat;
 
     /// <summary>
@@ -26,6 +32,7 @@ public LocalDateType(
         : base(name, bind)
     {
         Description = description;
+        SpecifiedBy = new Uri(SpecifiedByUri);
         _enforceSpecFormat = !disableFormatCheck;
     }
 
diff --git a/src/HotChocolate/Core/test/Execution.Tests/__resources__/Crypto.graphql b/src/HotChocolate/Core/test/Execution.Tests/__resources__/Crypto.graphql
@@ -350,7 +350,7 @@ type HistoryEdge {
 }
 
 """
-The `DateTime` scalar represents an ISO-8601 compliant date time type.
+The `DateTime` scalar represents an exact point in time. This point in time is specified by having an offset to UTC and does not use a time zone.
 """
 scalar DateTime
 
diff --git a/src/HotChocolate/Core/test/Types.Tests/Configuration/__snapshots__/TypeDiscoveryTests.InferDateTime.snap b/src/HotChocolate/Core/test/Types.Tests/Configuration/__snapshots__/TypeDiscoveryTests.InferDateTime.snap
@@ -1,4 +1,4 @@
-﻿schema {
+schema {
   query: QueryWithDateTime
 }
 
@@ -10,5 +10,5 @@ type QueryWithDateTime {
 "The `@specifiedBy` directive is used within the type system definition language to provide a URL for specifying the behavior of custom scalar definitions."
 directive @specifiedBy("The specifiedBy URL points to a human-readable specification. This field will only read a result for scalar types." url: String!) on SCALAR
 
-"The `DateTime` scalar represents an ISO-8601 compliant date time type."
+"The `DateTime` scalar represents an exact point in time. This point in time is specified by having an offset to UTC and does not use a time zone."
 scalar DateTime @specifiedBy(url: "https:\/\/scalars.graphql.org\/andimarek\/date-time.html")
diff --git a/src/HotChocolate/Core/test/Types.Tests/Configuration/__snapshots__/TypeDiscoveryTests.InferDateTimeFromModel.snap b/src/HotChocolate/Core/test/Types.Tests/Configuration/__snapshots__/TypeDiscoveryTests.InferDateTimeFromModel.snap
@@ -51,5 +51,5 @@ directive @specifiedBy("The specifiedBy URL points to a human-readable specifica
 "The `Date` scalar represents an ISO-8601 compliant date type."
 scalar Date
 
-"The `DateTime` scalar represents an ISO-8601 compliant date time type."
+"The `DateTime` scalar represents an exact point in time. This point in time is specified by having an offset to UTC and does not use a time zone."
 scalar DateTime @specifiedBy(url: "https:\/\/scalars.graphql.org\/andimarek\/date-time.html")
diff --git a/src/HotChocolate/Core/test/Types.Tests/Configuration/__snapshots__/TypeDiscoveryTests.TypeDiscovery_Should_InferStructs.snap b/src/HotChocolate/Core/test/Types.Tests/Configuration/__snapshots__/TypeDiscoveryTests.TypeDiscovery_Should_InferStructs.snap
@@ -21,7 +21,7 @@ type QueryTypeWithStruct {
 "The `@specifiedBy` directive is used within the type system definition language to provide a URL for specifying the behavior of custom scalar definitions."
 directive @specifiedBy("The specifiedBy URL points to a human-readable specification. This field will only read a result for scalar types." url: String!) on SCALAR
 
-"The `DateTime` scalar represents an ISO-8601 compliant date time type."
+"The `DateTime` scalar represents an exact point in time. This point in time is specified by having an offset to UTC and does not use a time zone."
 scalar DateTime @specifiedBy(url: "https:\/\/scalars.graphql.org\/andimarek\/date-time.html")
 
 scalar UUID @specifiedBy(url: "https:\/\/tools.ietf.org\/html\/rfc4122")
diff --git a/src/HotChocolate/Core/test/Types.Tests/Types/Directives/SpecifiedByDirectiveTypeTests.cs b/src/HotChocolate/Core/test/Types.Tests/Types/Directives/SpecifiedByDirectiveTypeTests.cs
@@ -57,7 +57,7 @@ type Query1 {
                     "The `@specifiedBy` directive is used within the type system definition language to provide a URL for specifying the behavior of custom scalar definitions."
                     directive @specifiedBy("The specifiedBy URL points to a human-readable specification. This field will only read a result for scalar types." url: String!) on SCALAR
 
-                    "The `DateTime` scalar represents an ISO-8601 compliant date time type."
+                    "The `DateTime` scalar represents an exact point in time. This point in time is specified by having an offset to UTC and does not use a time zone."
                     scalar DateTime @specifiedBy(url: "https:\/\/scalars.graphql.org\/andimarek\/date-time.html")
                     """)
                 .UseField(next => next)
diff --git a/src/HotChocolate/Core/test/Types.Tests/Types/Directives/__snapshots__/SpecifiedByDirectiveTypeTests.EnsureSpecifiedByDirectiveExistsInSdl.graphql b/src/HotChocolate/Core/test/Types.Tests/Types/Directives/__snapshots__/SpecifiedByDirectiveTypeTests.EnsureSpecifiedByDirectiveExistsInSdl.graphql
@@ -9,5 +9,5 @@ type Query1 {
 "The `@specifiedBy` directive is used within the type system definition language to provide a URL for specifying the behavior of custom scalar definitions."
 directive @specifiedBy("The specifiedBy URL points to a human-readable specification. This field will only read a result for scalar types." url: String!) on SCALAR
 
-"The `DateTime` scalar represents an ISO-8601 compliant date time type."
+"The `DateTime` scalar represents an exact point in time. This point in time is specified by having an offset to UTC and does not use a time zone."
 scalar DateTime @specifiedBy(url: "https:\/\/scalars.graphql.org\/andimarek\/date-time.html")
diff --git a/src/HotChocolate/Core/test/Types.Tests/Types/Scalars/__snapshots__/LocalDateTypeTests.DateOnly_As_Argument_Schema.snap b/src/HotChocolate/Core/test/Types.Tests/Types/Scalars/__snapshots__/LocalDateTypeTests.DateOnly_As_Argument_Schema.snap
@@ -10,5 +10,8 @@ type QueryDateTime1 {
   foo: Foo!
 }
 
-"The `LocalDate` scalar type represents an ISO date string, represented as UTF-8 character sequences YYYY-MM-DD. The scalar follows the specification defined in RFC3339"
-scalar LocalDate
+"The `@specifiedBy` directive is used within the type system definition language to provide a URL for specifying the behavior of custom scalar definitions."
+directive @specifiedBy("The specifiedBy URL points to a human-readable specification. This field will only read a result for scalar types." url: String!) on SCALAR
+
+"The `LocalDate` scalar represents a date without a time-zone in the ISO-8601 calendar system."
+scalar LocalDate @specifiedBy(url: "https:\/\/scalars.graphql.org\/andimarek\/local-date.html")
diff --git a/src/HotChocolate/Core/test/Types.Tests/Types/Scalars/__snapshots__/LocalDateTypeTests.DateOnly_As_ReturnValue_Schema.snap b/src/HotChocolate/Core/test/Types.Tests/Types/Scalars/__snapshots__/LocalDateTypeTests.DateOnly_As_ReturnValue_Schema.snap
@@ -10,5 +10,8 @@ type QueryDateTime2 {
   bar: Bar!
 }
 
-"The `LocalDate` scalar type represents an ISO date string, represented as UTF-8 character sequences YYYY-MM-DD. The scalar follows the specification defined in RFC3339"
-scalar LocalDate
+"The `@specifiedBy` directive is used within the type system definition language to provide a URL for specifying the behavior of custom scalar definitions."
+directive @specifiedBy("The specifiedBy URL points to a human-readable specification. This field will only read a result for scalar types." url: String!) on SCALAR
+
+"The `LocalDate` scalar represents a date without a time-zone in the ISO-8601 calendar system."
+scalar LocalDate @specifiedBy(url: "https:\/\/scalars.graphql.org\/andimarek\/local-date.html")
diff --git a/src/HotChocolate/Core/test/Types.Tests/__snapshots__/CodeFirstTests.Change_DefaultBinding_For_DateTime.snap b/src/HotChocolate/Core/test/Types.Tests/__snapshots__/CodeFirstTests.Change_DefaultBinding_For_DateTime.snap
@@ -17,5 +17,5 @@ directive @specifiedBy("The specifiedBy URL points to a human-readable specifica
 "The `Date` scalar represents an ISO-8601 compliant date type."
 scalar Date
 
-"The `DateTime` scalar represents an ISO-8601 compliant date time type."
+"The `DateTime` scalar represents an exact point in time. This point in time is specified by having an offset to UTC and does not use a time zone."
 scalar DateTime @specifiedBy(url: "https:\/\/scalars.graphql.org\/andimarek\/date-time.html")
diff --git a/src/HotChocolate/Data/test/Data.Filters.Tests/Types/__snapshots__/ComparableOperationInputTests.Create_Implicit_Operation.graphql b/src/HotChocolate/Data/test/Data.Filters.Tests/Types/__snapshots__/ComparableOperationInputTests.Create_Implicit_Operation.graphql
@@ -338,8 +338,8 @@ scalar Byte
 "The `Decimal` scalar type represents a decimal floating-point number."
 scalar Decimal
 
-"The `LocalDate` scalar type represents an ISO date string, represented as UTF-8 character sequences YYYY-MM-DD. The scalar follows the specification defined in RFC3339"
-scalar LocalDate
+"The `LocalDate` scalar represents a date without a time-zone in the ISO-8601 calendar system."
+scalar LocalDate @specifiedBy(url: "https:\/\/scalars.graphql.org\/andimarek\/local-date.html")
 
 "The LocalTime scalar type is a local time string (i.e., with no associated timezone) in 24-hr HH:mm:ss."
 scalar LocalTime
diff --git a/src/HotChocolate/Data/test/Data.Filters.Tests/Types/__snapshots__/ComparableOperationInputTests.Create_Implicit_Operation_Normalized.graphql b/src/HotChocolate/Data/test/Data.Filters.Tests/Types/__snapshots__/ComparableOperationInputTests.Create_Implicit_Operation_Normalized.graphql
@@ -188,8 +188,8 @@ scalar Byte
 "The `Decimal` scalar type represents a decimal floating-point number."
 scalar Decimal
 
-"The `LocalDate` scalar type represents an ISO date string, represented as UTF-8 character sequences YYYY-MM-DD. The scalar follows the specification defined in RFC3339"
-scalar LocalDate
+"The `LocalDate` scalar represents a date without a time-zone in the ISO-8601 calendar system."
+scalar LocalDate @specifiedBy(url: "https:\/\/scalars.graphql.org\/andimarek\/local-date.html")
 
 "The LocalTime scalar type is a local time string (i.e., with no associated timezone) in 24-hr HH:mm:ss."
 scalar LocalTime
diff --git a/src/HotChocolate/MongoDb/test/Data.MongoDb.Filters.Tests/__snapshots__/MongoDbFilterVisitorComparableTests.Create_Implicit_Operation.graphql b/src/HotChocolate/MongoDb/test/Data.MongoDb.Filters.Tests/__snapshots__/MongoDbFilterVisitorComparableTests.Create_Implicit_Operation.graphql
@@ -142,7 +142,7 @@ input FooFilterInput {
 "The `@specifiedBy` directive is used within the type system definition language to provide a URL for specifying the behavior of custom scalar definitions."
 directive @specifiedBy("The specifiedBy URL points to a human-readable specification. This field will only read a result for scalar types." url: String!) on SCALAR
 
-"The `DateTime` scalar represents an ISO-8601 compliant date time type."
+"The `DateTime` scalar represents an exact point in time. This point in time is specified by having an offset to UTC and does not use a time zone."
 scalar DateTime @specifiedBy(url: "https:\/\/scalars.graphql.org\/andimarek\/date-time.html")
 
 "The `Decimal` scalar type represents a decimal floating-point number."
diff --git a/src/HotChocolate/MongoDb/test/Data.MongoDb.Filters.Tests/__snapshots__/MongoDbFilterVisitorComparableTests.Create_Implicit_Operation_Normalized.graphql b/src/HotChocolate/MongoDb/test/Data.MongoDb.Filters.Tests/__snapshots__/MongoDbFilterVisitorComparableTests.Create_Implicit_Operation_Normalized.graphql
@@ -127,7 +127,7 @@ input UuidOperationFilterInput {
 "The `@specifiedBy` directive is used within the type system definition language to provide a URL for specifying the behavior of custom scalar definitions."
 directive @specifiedBy("The specifiedBy URL points to a human-readable specification. This field will only read a result for scalar types." url: String!) on SCALAR
 
-"The `DateTime` scalar represents an ISO-8601 compliant date time type."
+"The `DateTime` scalar represents an exact point in time. This point in time is specified by having an offset to UTC and does not use a time zone."
 scalar DateTime @specifiedBy(url: "https:\/\/scalars.graphql.org\/andimarek\/date-time.html")
 
 "The `Decimal` scalar type represents a decimal floating-point number."
diff --git a/src/HotChocolate/Utilities/test/Utilities.Introspection.Tests/__resources__/StarWarsIntrospectionResult.json b/src/HotChocolate/Utilities/test/Utilities.Introspection.Tests/__resources__/StarWarsIntrospectionResult.json
@@ -83,7 +83,7 @@
         {
           "kind": "SCALAR",
           "name": "DateTime",
-          "description": "The `DateTime` scalar represents an ISO-8601 compliant date time type.",
+          "description": "The `DateTime` scalar represents an exact point in time. This point in time is specified by having an offset to UTC and does not use a time zone.",
           "fields": null,
           "inputFields": null,
           "interfaces": null,
diff --git a/src/HotChocolate/Utilities/test/Utilities.Introspection.Tests/__snapshots__/IntrospectionFormatterTests.DeserializeStarWarsIntrospectionResult.snap b/src/HotChocolate/Utilities/test/Utilities.Introspection.Tests/__snapshots__/IntrospectionFormatterTests.DeserializeStarWarsIntrospectionResult.snap
@@ -23,7 +23,7 @@ scalar Decimal
 
 scalar Long
 
-"The `DateTime` scalar represents an ISO-8601 compliant date time type."
+"The `DateTime` scalar represents an exact point in time. This point in time is specified by having an offset to UTC and does not use a time zone."
 scalar DateTime
 
 "The `Date` scalar represents an ISO-8601 compliant date type."
diff --git a/src/Nitro/CommandLine/src/CommandLine.Cloud/schema.graphql b/src/Nitro/CommandLine/src/CommandLine.Cloud/schema.graphql
@@ -3530,7 +3530,7 @@ directive @defer("Deferred when true." if: Boolean "If this argument label has a
 
 scalar Any
 
-"The `DateTime` scalar represents an ISO-8601 compliant date time type."
+"The `DateTime` scalar represents an exact point in time. This point in time is specified by having an offset to UTC and does not use a time zone."
 scalar DateTime @specifiedBy(url: "https:\/\/scalars.graphql.org\/andimarek\/date-time.html")
 
 "The `Long` scalar type represents non-fractional signed whole 64-bit numeric values. Long can represent values between -(2^63) and 2^63 - 1."
diff --git a/src/StrawberryShake/CodeGeneration/test/CodeGeneration.CSharp.Tests/__resources__/ActiveDirectory.Schema.graphql b/src/StrawberryShake/CodeGeneration/test/CodeGeneration.CSharp.Tests/__resources__/ActiveDirectory.Schema.graphql
@@ -1195,7 +1195,7 @@ scalar Long
 "The `Date` scalar represents an ISO-8601 compliant date type."
 scalar Date
 
-"The `DateTime` scalar represents an ISO-8601 compliant date time type."
+"The `DateTime` scalar represents an exact point in time. This point in time is specified by having an offset to UTC and does not use a time zone."
 scalar DateTime
 
 scalar Url
diff --git a/src/StrawberryShake/CodeGeneration/test/CodeGeneration.CSharp.Tests/__resources__/ChatSchema.graphql b/src/StrawberryShake/CodeGeneration/test/CodeGeneration.CSharp.Tests/__resources__/ChatSchema.graphql
@@ -346,7 +346,7 @@ enum Direction {
   OUTGOING
 }
 
-"The `DateTime` scalar represents an ISO-8601 compliant date time type."
+"The `DateTime` scalar represents an exact point in time. This point in time is specified by having an offset to UTC and does not use a time zone."
 scalar DateTime
 
 scalar Url
diff --git a/src/StrawberryShake/CodeGeneration/test/CodeGeneration.CSharp.Tests/__resources__/Expenses.graphql b/src/StrawberryShake/CodeGeneration/test/CodeGeneration.CSharp.Tests/__resources__/Expenses.graphql
@@ -73,7 +73,7 @@ enum ExpenseCategory {
   PERSONAL_CARE
 }
 
-"The `DateTime` scalar represents an ISO-8601 compliant date time type."
+"The `DateTime` scalar represents an exact point in time. This point in time is specified by having an offset to UTC and does not use a time zone."
 scalar DateTime
 
 scalar UUID
diff --git a/src/StrawberryShake/CodeGeneration/test/CodeGeneration.CSharp.Tests/__resources__/FieldsWithUnderlinePrefix.graphql b/src/StrawberryShake/CodeGeneration/test/CodeGeneration.CSharp.Tests/__resources__/FieldsWithUnderlinePrefix.graphql
@@ -272,7 +272,7 @@ type Mutation {
 }
 
 """
-The `DateTime` scalar represents an ISO-8601 compliant date time type.
+The `DateTime` scalar represents an exact point in time. This point in time is specified by having an offset to UTC and does not use a time zone.
 """
 scalar DateTime
 
diff --git a/src/StrawberryShake/CodeGeneration/test/CodeGeneration.CSharp.Tests/__resources__/PaymentSchema.graphql b/src/StrawberryShake/CodeGeneration/test/CodeGeneration.CSharp.Tests/__resources__/PaymentSchema.graphql
@@ -7675,7 +7675,7 @@ directive @stream("Streamed when true." if: Boolean "The initial elements that s
 "The `Date` scalar represents an ISO-8601 compliant date type."
 scalar Date
 
-"The `DateTime` scalar represents an ISO-8601 compliant date time type."
+"The `DateTime` scalar represents an exact point in time. This point in time is specified by having an offset to UTC and does not use a time zone."
 scalar DateTime @specifiedBy(url: "https:\/\/scalars.graphql.org\/andimarek\/date-time.html")
 
 "The `Decimal` scalar type represents a decimal floating-point number."
diff --git a/src/StrawberryShake/CodeGeneration/test/CodeGeneration.CSharp.Tests/__resources__/Schema_Bug_2.graphql b/src/StrawberryShake/CodeGeneration/test/CodeGeneration.CSharp.Tests/__resources__/Schema_Bug_2.graphql
@@ -515,7 +515,7 @@ type ProjectUserPermissions {
   canLeave: Boolean!
 }
 
-"The `DateTime` scalar represents an ISO-8601 compliant date time type."
+"The `DateTime` scalar represents an exact point in time. This point in time is specified by having an offset to UTC and does not use a time zone."
 scalar DateTime
 
 type ProjectShareInvitation {
diff --git a/src/StrawberryShake/CodeGeneration/test/CodeGeneration.CSharp.Tests/__resources__/Workshop.Schema.graphql b/src/StrawberryShake/CodeGeneration/test/CodeGeneration.CSharp.Tests/__resources__/Workshop.Schema.graphql
@@ -108,7 +108,7 @@ type SessionEdge {
   node: Session!
 }
 
-"The `DateTime` scalar represents an ISO-8601 compliant date time type."
+"The `DateTime` scalar represents an exact point in time. This point in time is specified by having an offset to UTC and does not use a time zone."
 scalar DateTime
 
 "The `TimeSpan` scalar represents an ISO-8601 compliant duration type."
diff --git a/website/src/docs/hotchocolate/v16/defining-a-schema/scalars.md b/website/src/docs/hotchocolate/v16/defining-a-schema/scalars.md

Original file line number	Diff line number	Diff line change
`@@ -350,7 +350,7 @@ type HistoryEdge {`
`350`	`350`	`}`
`351`	`351`
`352`	`352`	`"""`
`353`		-The `DateTime` scalar represents an ISO-8601 compliant date time type.
	`353`	+The `DateTime` scalar represents an exact point in time. This point in time is specified by having an offset to UTC and does not use a time zone.
`354`	`354`	`"""`
`355`	`355`	`scalar DateTime`
`356`	`356`