Skip to content

Commit db41a3c

Browse files
baywetCopilot
baywet
and
Copilot
committed
feat(library): add missing json schema properties
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent a058913 commit db41a3c

14 files changed

Lines changed: 782 additions & 30 deletions

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ public interface IOpenApiSchema : IOpenApiDescribedElement, IOpenApiReadOnlyExte
260260
/// <summary>
261261
/// Indicates whether unevaluated properties are allowed. When false, no unevaluated properties are permitted.
262262
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-core#name-unevaluatedproperties
263-
/// Only serialized when false and UnevaluatedPropertiesSchema (from IOpenApiSchemaWithUnevaluatedProperties) is null.
263+
/// Only serialized when false and UnevaluatedPropertiesSchema (from IOpenApiSchemaMissingProperties) is null.
264264
/// </summary>
265265
/// <remarks>
266266
/// NOTE: This property differs from the naming pattern of AdditionalPropertiesAllowed for binary compatibility reasons.

‎src/Microsoft.OpenApi/Models/Interfaces/IOpenApiSchemaMissingProperties.cs‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
using System.Collections.Generic;
2+
3+
namespace Microsoft.OpenApi;
4+
5+
/// <summary>
6+
/// Compatibility interface for schema properties that cannot be added to <see cref="IOpenApiSchema"/>
7+
/// in the current major version without a breaking change.
8+
/// This interface provides access to those properties in contexts where callers need a typed model surface.
9+
/// </summary>
10+
/// <remarks>
11+
/// TODO: Remove this interface in the next major version and merge its content into IOpenApiSchema.
12+
/// </remarks>
13+
public interface IOpenApiSchemaMissingProperties
14+
{
15+
/// <summary>
16+
/// $anchor - identifies a plain-name location-independent fragment within the schema resource.
17+
/// </summary>
18+
public string? Anchor { get; }
19+
20+
/// <summary>
21+
/// Indicates whether unevaluated properties are allowed. When false, no unevaluated properties are permitted.
22+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-core#name-unevaluatedproperties
23+
/// Only serialized when false and <see cref="UnevaluatedPropertiesSchema"/> is null.
24+
/// </summary>
25+
/// <remarks>
26+
/// NOTE: This property differs from the naming pattern of AdditionalPropertiesAllowed for binary compatibility reasons.
27+
/// In the next major version, this will be renamed to UnevaluatedPropertiesAllowed.
28+
/// TODO: Rename to UnevaluatedPropertiesAllowed in the next major version.
29+
/// </remarks>
30+
public bool UnevaluatedProperties { get; }
31+
32+
/// <summary>
33+
/// Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-core#name-unevaluatedproperties
34+
/// This is a schema that unevaluated properties must validate against.
35+
/// When serialized, this takes precedence over the <see cref="UnevaluatedProperties"/> boolean property.
36+
/// </summary>
37+
/// <remarks>
38+
/// NOTE: This property differs from the naming pattern of AdditionalProperties/AdditionalPropertiesAllowed
39+
/// for binary compatibility reasons. In the next major version:
40+
/// - This property will be renamed to UnevaluatedProperties
41+
/// - The current boolean UnevaluatedProperties property will be renamed to UnevaluatedPropertiesAllowed
42+
///
43+
/// TODO: Rename this property to UnevaluatedProperties in the next major version.
44+
/// </remarks>
45+
public IOpenApiSchema? UnevaluatedPropertiesSchema { get; }
46+
47+
/// <summary>
48+
/// contentEncoding - identifies the encoding of string content.
49+
/// </summary>
50+
public string? ContentEncoding { get; }
51+
52+
/// <summary>
53+
/// contentMediaType - identifies the media type of string content.
54+
/// </summary>
55+
public string? ContentMediaType { get; }
56+
57+
/// <summary>
58+
/// contentSchema - provides a schema that describes the decoded string content.
59+
/// </summary>
60+
public IOpenApiSchema? ContentSchema { get; }
61+
62+
/// <summary>
63+
/// propertyNames - provides a schema that validates property names.
64+
/// </summary>
65+
public IOpenApiSchema? PropertyNames { get; }
66+
67+
/// <summary>
68+
/// dependentSchemas - maps property names to schemas that are applied when that property is present.
69+
/// </summary>
70+
public IDictionary<string, IOpenApiSchema>? DependentSchemas { get; }
71+
72+
/// <summary>
73+
/// if - applies a conditional schema that determines whether <see cref="Then"/> or <see cref="Else"/> should be evaluated.
74+
/// </summary>
75+
public IOpenApiSchema? If { get; }
76+
77+
/// <summary>
78+
/// then - applies when <see cref="If"/> evaluates successfully.
79+
/// </summary>
80+
public IOpenApiSchema? Then { get; }
81+
82+
/// <summary>
83+
/// else - applies when <see cref="If"/> does not evaluate successfully.
84+
/// </summary>
85+
public IOpenApiSchema? Else { get; }
86+
}

‎src/Microsoft.OpenApi/Models/Interfaces/IOpenApiSchemaWithUnevaluatedProperties.cs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
using System;
2+
13
namespace Microsoft.OpenApi;
24

35
/// <summary>
@@ -13,6 +15,7 @@ namespace Microsoft.OpenApi;
1315
/// <remarks>
1416
/// TODO: Remove this interface in the next major version and merge its content into IOpenApiSchema.
1517
/// </remarks>
18+
[Obsolete("Use IOpenApiSchemaMissingProperties instead.")]
1619
public interface IOpenApiSchemaWithUnevaluatedProperties
1720
{
1821
/// <summary>

‎src/Microsoft.OpenApi/Models/OpenApiConstants.cs‎

Lines changed: 97 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,11 @@ public static class OpenApiConstants
8585
/// </summary>
8686
public const string Vocabulary = "$vocabulary";
8787

88+
/// <summary>
89+
/// Field: Anchor
90+
/// </summary>
91+
public const string Anchor = "$anchor";
92+
8893
/// <summary>
8994
/// Field: DynamicRef
9095
/// </summary>
@@ -126,9 +131,14 @@ public static class OpenApiConstants
126131
public const string UnevaluatedProperties = "unevaluatedProperties";
127132

128133
/// <summary>
129-
/// Extension: x-jsonschema-unevaluatedProperties
134+
/// Extension: x-oai-unevaluatedProperties
135+
/// </summary>
136+
public const string UnevaluatedPropertiesExtension = "x-oai-unevaluatedProperties";
137+
138+
/// <summary>
139+
/// Legacy extension: x-jsonschema-unevaluatedProperties
130140
/// </summary>
131-
public const string UnevaluatedPropertiesExtension = "x-jsonschema-unevaluatedProperties";
141+
public const string LegacyUnevaluatedPropertiesExtension = "x-jsonschema-unevaluatedProperties";
132142

133143
/// <summary>
134144
/// Field: Version
@@ -495,11 +505,51 @@ public static class OpenApiConstants
495505
/// </summary>
496506
public const string PatternProperties = "patternProperties";
497507

508+
/// <summary>
509+
/// Field: PropertyNames
510+
/// </summary>
511+
public const string PropertyNames = "propertyNames";
512+
498513
/// <summary>
499514
/// Extension: x-jsonschema-patternProperties
500515
/// </summary>
501516
public const string PatternPropertiesExtension = "x-jsonschema-patternProperties";
502517

518+
/// <summary>
519+
/// Field: DependentSchemas
520+
/// </summary>
521+
public const string DependentSchemas = "dependentSchemas";
522+
523+
/// <summary>
524+
/// Field: If
525+
/// </summary>
526+
public const string If = "if";
527+
528+
/// <summary>
529+
/// Field: Then
530+
/// </summary>
531+
public const string Then = "then";
532+
533+
/// <summary>
534+
/// Field: Else
535+
/// </summary>
536+
public const string Else = "else";
537+
538+
/// <summary>
539+
/// Field: ContentEncoding
540+
/// </summary>
541+
public const string ContentEncoding = "contentEncoding";
542+
543+
/// <summary>
544+
/// Field: ContentMediaType
545+
/// </summary>
546+
public const string ContentMediaType = "contentMediaType";
547+
548+
/// <summary>
549+
/// Field: ContentSchema
550+
/// </summary>
551+
public const string ContentSchema = "contentSchema";
552+
503553
/// <summary>
504554
/// Field: AdditionalProperties
505555
/// </summary>
@@ -735,6 +785,51 @@ public static class OpenApiConstants
735785
/// </summary>
736786
public const string DependentRequired = "dependentRequired";
737787

788+
/// <summary>
789+
/// Extension: x-oai-$anchor
790+
/// </summary>
791+
public const string AnchorExtension = "x-oai-$anchor";
792+
793+
/// <summary>
794+
/// Extension: x-oai-propertyNames
795+
/// </summary>
796+
public const string PropertyNamesExtension = "x-oai-propertyNames";
797+
798+
/// <summary>
799+
/// Extension: x-oai-dependentSchemas
800+
/// </summary>
801+
public const string DependentSchemasExtension = "x-oai-dependentSchemas";
802+
803+
/// <summary>
804+
/// Extension: x-oai-if
805+
/// </summary>
806+
public const string IfExtension = "x-oai-if";
807+
808+
/// <summary>
809+
/// Extension: x-oai-then
810+
/// </summary>
811+
public const string ThenExtension = "x-oai-then";
812+
813+
/// <summary>
814+
/// Extension: x-oai-else
815+
/// </summary>
816+
public const string ElseExtension = "x-oai-else";
817+
818+
/// <summary>
819+
/// Extension: x-oai-contentEncoding
820+
/// </summary>
821+
public const string ContentEncodingExtension = "x-oai-contentEncoding";
822+
823+
/// <summary>
824+
/// Extension: x-oai-contentMediaType
825+
/// </summary>
826+
public const string ContentMediaTypeExtension = "x-oai-contentMediaType";
827+
828+
/// <summary>
829+
/// Extension: x-oai-contentSchema
830+
/// </summary>
831+
public const string ContentSchemaExtension = "x-oai-contentSchema";
832+
738833
#region V2.0
739834

740835
/// <summary>

0 commit comments

Comments
 (0)