Skip to content

Commit d9b0c90

Browse files
authored
Merge pull request #2362 from microsoft/fix/json-schema-doc-comment
fix: wrong link to json schema spec in schema doc comments
2 parents 9791eb6 + 9a73ec6 commit d9b0c90

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

src/Microsoft.OpenApi/Models/Interfaces/IOpenApiSchema.cs

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -55,17 +55,17 @@ public interface IOpenApiSchema : IOpenApiDescribedElement, IOpenApiReadOnlyExte
5555
public Dictionary<string, IOpenApiSchema>? Definitions { get; }
5656

5757
/// <summary>
58-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
58+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
5959
/// </summary>
6060
public string? ExclusiveMaximum { get; }
6161

6262
/// <summary>
63-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
63+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
6464
/// </summary>
6565
public string? ExclusiveMinimum { get; }
6666

6767
/// <summary>
68-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
68+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
6969
/// Value MUST be a string in V2 and V3.
7070
/// </summary>
7171
public JsonSchemaType? Type { get; }
@@ -76,45 +76,45 @@ public interface IOpenApiSchema : IOpenApiDescribedElement, IOpenApiReadOnlyExte
7676
public string? Const { get; }
7777

7878
/// <summary>
79-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
79+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
8080
/// While relying on JSON Schema's defined formats,
8181
/// the OAS offers a few additional predefined formats.
8282
/// </summary>
8383
public string? Format { get; }
8484

8585
/// <summary>
86-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
86+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
8787
/// </summary>
8888
public string? Maximum { get; }
8989

9090
/// <summary>
91-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
91+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
9292
/// </summary>
9393
public string? Minimum { get; }
9494

9595
/// <summary>
96-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
96+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
9797
/// </summary>
9898
public int? MaxLength { get; }
9999

100100
/// <summary>
101-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
101+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
102102
/// </summary>
103103
public int? MinLength { get; }
104104

105105
/// <summary>
106-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
106+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
107107
/// This string SHOULD be a valid regular expression, according to the ECMA 262 regular expression dialect
108108
/// </summary>
109109
public string? Pattern { get; }
110110

111111
/// <summary>
112-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
112+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
113113
/// </summary>
114114
public decimal? MultipleOf { get; }
115115

116116
/// <summary>
117-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
117+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
118118
/// The default value represents what would be assumed by the consumer of the input as the value of the schema if one is not provided.
119119
/// Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object defined at the same level.
120120
/// For example, if type is string, then default can be "foo" but cannot be 1.
@@ -142,64 +142,64 @@ public interface IOpenApiSchema : IOpenApiDescribedElement, IOpenApiReadOnlyExte
142142
public bool WriteOnly { get; }
143143

144144
/// <summary>
145-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
145+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
146146
/// Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
147147
/// </summary>
148148
public List<IOpenApiSchema>? AllOf { get; }
149149

150150
/// <summary>
151-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
151+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
152152
/// Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
153153
/// </summary>
154154
public List<IOpenApiSchema>? OneOf { get; }
155155

156156
/// <summary>
157-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
157+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
158158
/// Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
159159
/// </summary>
160160
public List<IOpenApiSchema>? AnyOf { get; }
161161

162162
/// <summary>
163-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
163+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
164164
/// Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
165165
/// </summary>
166166
public IOpenApiSchema? Not { get; }
167167

168168
/// <summary>
169-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
169+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
170170
/// </summary>
171171
public HashSet<string>? Required { get; }
172172

173173
/// <summary>
174-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
174+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
175175
/// Value MUST be an object and not an array. Inline or referenced schema MUST be of a Schema Object
176176
/// and not a standard JSON Schema. items MUST be present if the type is array.
177177
/// </summary>
178178
public IOpenApiSchema? Items { get; }
179179

180180
/// <summary>
181-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
181+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
182182
/// </summary>
183183
public int? MaxItems { get; }
184184

185185
/// <summary>
186-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
186+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
187187
/// </summary>
188188
public int? MinItems { get; }
189189

190190
/// <summary>
191-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
191+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
192192
/// </summary>
193193
public bool? UniqueItems { get; }
194194

195195
/// <summary>
196-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
196+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
197197
/// Property definitions MUST be a Schema Object and not a standard JSON Schema (inline or referenced).
198198
/// </summary>
199199
public Dictionary<string, IOpenApiSchema>? Properties { get; }
200200

201201
/// <summary>
202-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
202+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
203203
/// PatternProperty definitions MUST be a Schema Object and not a standard JSON Schema (inline or referenced)
204204
/// Each property name of this object SHOULD be a valid regular expression according to the ECMA 262 r
205205
/// egular expression dialect. Each property value of this object MUST be an object, and each object MUST
@@ -208,12 +208,12 @@ public interface IOpenApiSchema : IOpenApiDescribedElement, IOpenApiReadOnlyExte
208208
public Dictionary<string, IOpenApiSchema>? PatternProperties { get; }
209209

210210
/// <summary>
211-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
211+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
212212
/// </summary>
213213
public int? MaxProperties { get; }
214214

215215
/// <summary>
216-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
216+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
217217
/// </summary>
218218
public int? MinProperties { get; }
219219

@@ -223,7 +223,7 @@ public interface IOpenApiSchema : IOpenApiDescribedElement, IOpenApiReadOnlyExte
223223
public bool AdditionalPropertiesAllowed { get; }
224224

225225
/// <summary>
226-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
226+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
227227
/// Value can be boolean or object. Inline or referenced schema
228228
/// MUST be of a Schema Object and not a standard JSON Schema.
229229
/// </summary>
@@ -250,12 +250,12 @@ public interface IOpenApiSchema : IOpenApiDescribedElement, IOpenApiReadOnlyExte
250250
public List<JsonNode>? Examples { get; }
251251

252252
/// <summary>
253-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
253+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
254254
/// </summary>
255255
public List<JsonNode>? Enum { get; }
256256

257257
/// <summary>
258-
/// Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
258+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
259259
/// </summary>
260260
public bool UnevaluatedProperties { get; }
261261

0 commit comments

Comments
 (0)