adds support for OpenAPI 3.1 descriptions #5936

baywet · 2024-12-23T15:37:21Z

fixes #3914

depends on microsoft/OpenAPI.NET#2023

In addition to "supporting the new format" this PR does a couple of things:

adds early support for external references.
adds support for type arrays (["number", "string"]) and projects them as union types.

Signed-off-by: Vincent Biret <[email protected]>

fix: missing descriptions Signed-off-by: Vincent Biret <[email protected]>

Signed-off-by: Vincent Biret <[email protected]>

src/Kiota.Builder/Extensions/OpenApiSchemaExtensions.cs

src/Kiota.Builder/KiotaBuilder.cs

Signed-off-by: Vincent Biret <[email protected]>

baywet · 2025-02-14T21:38:46Z

and the unit tests are impacted by this bug microsoft/OpenAPI.NET#2150

src/Kiota.Builder/OpenApiExtensions/OpenApiKiotaMergedExtension.cs

Signed-off-by: Vincent Biret <[email protected]>

andrueastman

👍🏼

src/Kiota.Builder/OpenApiExtensions/OpenApiKiotaMergedExtension.cs

baywet · 2025-02-19T12:06:44Z

for anybody following along, we'll need to wait for the release of this fix.
microsoft/OpenAPI.NET#2157

microsoft/OpenAPI.NET#2158

…o feat/OAI-3-1

src/Kiota.Builder/Configuration/LanguagesInformation.cs

calebkiage · 2025-02-20T12:50:29Z

src/Kiota.Builder/EqualityComparers/OpenApiSchemaReferenceComparer.cs

    {
-        if (string.IsNullOrEmpty(x?.Reference?.Id) || string.IsNullOrEmpty(y?.Reference?.Id)) return object.Equals(x, y);
-        return _stringComparer.Equals(x.Reference.Id, y.Reference.Id);
+        if (x is not OpenApiSchemaReference xRef || y is not OpenApiSchemaReference yRef) return object.Equals(x, y);


If Id can be null, then the existing condition may change the behavior of this comparer.

Suggested change

if (x is not OpenApiSchemaReference xRef || y is not OpenApiSchemaReference yRef) return object.Equals(x, y);

if (x is not OpenApiSchemaReference xRef || string.IsNullOrEmpty(xRef.Reference?.Id) || y is not OpenApiSchemaReference yRef || string.IsNullOrEmpty(yRef.Reference?.Id)) return object.Equals(x, y);

this is temporary so the compiler doesn't yell at me. We're having a conversation about this here when it's fixed, I suspect the compiler will yell at me for using null propagation where not needed, at which point I'll remove it.

calebkiage · 2025-02-20T12:58:54Z

src/Kiota.Builder/Extensions/OpenApiDocumentExtensions.cs

@@ -19,7 +20,7 @@ internal static void InitializeInheritanceIndex(this OpenApiDocument openApiDocu
            {
                inheritanceIndex.TryAdd(entry.Key, new(StringComparer.OrdinalIgnoreCase));
                if (entry.Value.AllOf != null)
-                    foreach (var allOfEntry in entry.Value.AllOf.Where(static x => !string.IsNullOrEmpty(x.Reference?.Id)))
+                    foreach (var allOfEntry in entry.Value.AllOf.OfType<OpenApiSchemaReference>())


In case the Id could be null?

Suggested change

foreach (var allOfEntry in entry.Value.AllOf.OfType<OpenApiSchemaReference>())

foreach (var allOfEntry in entry.Value.AllOf.Where(static x => x is OpenApiSchemaReference xRef && !string.IsNullOrEmpty(x.Reference?.Id))

I believe we need to maintain the OfType for the rest of the code.
So I'm going to reply with this suggestion

Suggested change

foreach (var allOfEntry in entry.Value.AllOf.OfType<OpenApiSchemaReference>())

foreach (var allOfEntry in entry.Value.AllOf.OfType<OpenApiSchemaReference>().Where(static x => x !string.IsNullOrEmpty(x.Reference?.Id))

sonarqubecloud · 2025-02-20T13:22:14Z

Quality Gate passed for 'kiota'

Issues
21 New issues
0 Accepted issues

Measures
0 Security Hotspots
80.3% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

baywet added 30 commits November 12, 2024 04:37

fix: oas extensions parsing

85194e4

Signed-off-by: Vincent Biret <[email protected]>

fix: multiple NRE

d83bc2f

Signed-off-by: Vincent Biret <[email protected]>

fix: additional NRE

99623e1

Signed-off-by: Vincent Biret <[email protected]>

chore: updates reference to oai.net preview

8392023

fix: additional 3.1 NRT and type reference fixes

25e4511

fix: additional 3.1 NRT and type reference fixes

99dcbfb

fix: wrong value comparison

6422b45

Signed-off-by: Vincent Biret <[email protected]>

fix: additional type and NRT fixes

4bff227

Signed-off-by: Vincent Biret <[email protected]>

fix: main project builds

229a425

Signed-off-by: Vincent Biret <[email protected]>

fix: all validation tests migrated to the new OAI.net object model

193a7b9

Signed-off-by: Vincent Biret <[email protected]>

fix: openapi extension migrated to new OAI.net model

294d80e

Signed-off-by: Vincent Biret <[email protected]>

fix: main tests build

2d87938

Signed-off-by: Vincent Biret <[email protected]>

Merge branch 'main' into feat/OAI-3-1

453bf9d

Signed-off-by: Vincent Biret <[email protected]>

fix: parsing of dependencies

57c7cb9

Signed-off-by: Vincent Biret <[email protected]>

fix: aligns dependencies versions

5db7ad0

Signed-off-by: Vincent Biret <[email protected]>

Merge branch 'main' into feat/OAI-3-1

2360204

chore: upgrades additional code

4c1866d

Merge branch 'main' into feat/OAI-3-1

291db8a

Signed-off-by: Vincent Biret <[email protected]>

chore: upgrades to OAI.net preview3

4daed72

Signed-off-by: Vincent Biret <[email protected]>

fix: registers missing reader

9c9f988

Signed-off-by: Vincent Biret <[email protected]>

fix: bad boolean algebra

9cebd6c

Signed-off-by: Vincent Biret <[email protected]>

chore: linting

893a5ae

Signed-off-by: Vincent Biret <[email protected]>

fix: class naming for discriminator mapping

c1e21aa

Signed-off-by: Vincent Biret <[email protected]>

fix: further fix of missing reference ids

5f7e287

Signed-off-by: Vincent Biret <[email protected]>

fix: wrong method overload use

77f3a55

Signed-off-by: Vincent Biret <[email protected]>

fix: wrong test data

66641be

Signed-off-by: Vincent Biret <[email protected]>

fix: missing readers

52ede22

fix: missing descriptions Signed-off-by: Vincent Biret <[email protected]>

fix: form encoded validation rule

85c67cd

Signed-off-by: Vincent Biret <[email protected]>

fix: validation rules registration

bc64b83

Signed-off-by: Vincent Biret <[email protected]>

Merge branch 'main' into feat/OAI-3-1

21c607f

Signed-off-by: Vincent Biret <[email protected]>

baywet commented Feb 14, 2025

View reviewed changes

src/Kiota.Builder/Extensions/OpenApiSchemaExtensions.cs Outdated Show resolved Hide resolved

baywet commented Feb 14, 2025

View reviewed changes

src/Kiota.Builder/KiotaBuilder.cs Outdated Show resolved Hide resolved

baywet requested a review from andrueastman February 14, 2025 15:49

baywet added 5 commits February 14, 2025 12:48

chore: adds sanity tests for primitive and null types

7d01be8

Signed-off-by: Vincent Biret <[email protected]>

feat: adds support for array of types as union types

a2e3a66

Signed-off-by: Vincent Biret <[email protected]>

chore: comment cleanup

62e83ac

Signed-off-by: Vincent Biret <[email protected]>

feat: adds support for external references

243168e

Signed-off-by: Vincent Biret <[email protected]>

fix: external reference anti-test update

b46eb2d

Signed-off-by: Vincent Biret <[email protected]>

baywet marked this pull request as ready for review February 14, 2025 20:13

baywet requested a review from a team as a code owner February 14, 2025 20:13

andrueastman reviewed Feb 17, 2025

View reviewed changes

src/Kiota.Builder/OpenApiExtensions/OpenApiKiotaMergedExtension.cs Show resolved Hide resolved

baywet added 6 commits February 17, 2025 08:05

Merge branch 'main' into feat/OAI-3-1

c76acd0

chore: bumps openapi deps

61b9cb9

fix: java issue with base64 types

e2de4a7

Signed-off-by: Vincent Biret <[email protected]>

fix: do not use null default values

c1aaae0

Signed-off-by: Vincent Biret <[email protected]>

fix: get primitive type for properties should ignore null

9097014

Signed-off-by: Vincent Biret <[email protected]>

fix: enum defensive statement for primitive types

0b63dd9

Signed-off-by: Vincent Biret <[email protected]>

andrueastman previously approved these changes Feb 18, 2025

View reviewed changes

src/Kiota.Builder/OpenApiExtensions/OpenApiKiotaMergedExtension.cs Show resolved Hide resolved

baywet and others added 3 commits February 18, 2025 12:30

Merge branch 'main' into feat/OAI-3-1

8baa61c

Merge branch 'main' into feat/OAI-3-1

3b8f550

Merge branch 'main' into feat/OAI-3-1

10871e4

baywet added 2 commits February 19, 2025 14:08

Merge branch 'main' into feat/OAI-3-1

352bd1f

Merge branch 'feat/OAI-3-1' of https://github.com/microsoft/kiota int…

f6a4b92

…o feat/OAI-3-1

calebkiage reviewed Feb 20, 2025

View reviewed changes

baywet added 2 commits February 20, 2025 08:13

Merge branch 'main' into feat/OAI-3-1

9ed17cb

chore: linting

990fd30

baywet dismissed andrueastman’s stale review via 990fd30 February 20, 2025 13:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

adds support for OpenAPI 3.1 descriptions #5936

adds support for OpenAPI 3.1 descriptions #5936

baywet commented Dec 23, 2024 •

edited

Loading

baywet commented Feb 14, 2025

andrueastman left a comment

baywet commented Feb 19, 2025 •

edited

Loading

calebkiage Feb 20, 2025

baywet Feb 20, 2025

calebkiage Feb 20, 2025

baywet Feb 20, 2025

sonarqubecloud bot commented Feb 20, 2025

	if (x is not OpenApiSchemaReference xRef \|\| y is not OpenApiSchemaReference yRef) return object.Equals(x, y);
	if (x is not OpenApiSchemaReference xRef \|\| string.IsNullOrEmpty(xRef.Reference?.Id) \|\| y is not OpenApiSchemaReference yRef \|\| string.IsNullOrEmpty(yRef.Reference?.Id)) return object.Equals(x, y);

	foreach (var allOfEntry in entry.Value.AllOf.OfType<OpenApiSchemaReference>())
	foreach (var allOfEntry in entry.Value.AllOf.Where(static x => x is OpenApiSchemaReference xRef && !string.IsNullOrEmpty(x.Reference?.Id))

adds support for OpenAPI 3.1 descriptions #5936

Are you sure you want to change the base?

adds support for OpenAPI 3.1 descriptions #5936

Conversation

baywet commented Dec 23, 2024 • edited Loading

baywet commented Feb 14, 2025

andrueastman left a comment

Choose a reason for hiding this comment

baywet commented Feb 19, 2025 • edited Loading

calebkiage Feb 20, 2025

Choose a reason for hiding this comment

baywet Feb 20, 2025

Choose a reason for hiding this comment

calebkiage Feb 20, 2025

Choose a reason for hiding this comment

baywet Feb 20, 2025

Choose a reason for hiding this comment

sonarqubecloud bot commented Feb 20, 2025

Quality Gate passed for 'kiota'

baywet commented Dec 23, 2024 •

edited

Loading

baywet commented Feb 19, 2025 •

edited

Loading