Adds support for generating Mermaid diagrams from APIs by darrelmiller · Pull Request #1113 · microsoft/OpenAPI.NET

Darrel (darrelmiller) · 2022-12-23T17:45:51Z

Added a show command to the hidi command line and also added a WriteMermaid function to the OpenApiUriTreeNode class.

Examples of the output are here https://github.com/darrelmiller/openapi-collection/tree/main/ApiDiagrams

The show command wraps the mermaid in a markdown file with a legend to explain the coloring of the nodes. Each node is styled with a color that maps to the set of HTTP methods that are supported. This mapping is defined by the MermaidColorScheme dictionary on OpenApiUriTreeNode. That dictionary can be customized to change the colors or add new combinations of HTTP methods.

GitHub markdown does not render the HTML legend that the show command emits. However, the VS code markdown preview does.

This closes#820

+ catch (Exception ex)
+ {
+#if DEBUG
+ logger.LogCritical(ex, ex.Message);
+ throw; // so debug tools go straight to the source of the exception when attached
+#else
+ logger.LogCritical( ex.Message);
+ return 1;
+#endif
+ }


+ writer.WriteLine();
+ writer.WriteLine("OpenAPI: " + openapi);
+
+ writer.WriteLine(@"<div>");


Vincent Biret (baywet)

a couple of comments on top of the ones already provided by codeql.
Also it seems you created your branch from master. I'd suggest rebasing from vnext for history sanity.

Darrel (darrelmiller) · 2022-12-25T00:22:11Z

Vincent Biret (@baywet) You tricked me with that .Order() method. It doesn't exist. At least my version of .NET doesn't know about it. I put the .OrderBy( o=>o) back.

Vincent Biret (baywet) · 2022-12-28T13:15:49Z

Vincent Biret (@baywet) You tricked me with that .Order() method. It doesn't exist. At least my version of .NET doesn't know about it. I put the .OrderBy( o=>o) back.

Darrel (@darrelmiller) ah right! it's an addition of .net 7, sorry about that, I'm in the future.

…ion issues

Co-authored-by: Vincent Biret <vibiret@microsoft.com>

…omments

Co-authored-by: Vincent Biret <vibiret@microsoft.com>

Darrel (darrelmiller) · 2023-01-03T22:19:44Z

OMG. I rebased successfully for the first time ever.

Vincent Biret (baywet)

Good job on the rebase, I hope you used the CLI :P

Darrel (darrelmiller) · 2023-01-04T14:52:59Z

Vincent Biret (@baywet) The git CLI, yes. I was lucky because there were no merge conflicts.

Darrel (darrelmiller) · 2023-01-12T03:28:24Z

Code coverage metric achieved. :-) /cc Maggie Kimani (@MaggieKimani1)Vincent Biret (@baywet)

Vincent Biret (baywet) · 2023-01-12T13:50:12Z

good job on the coverage. I encourage you to check the code smells to wrap this up (+ the comment I left) https://sonarcloud.io/project/issues?id=microsoft_OpenAPI.NET&pullRequest=1113&resolved=false&types=CODE_SMELL

…and GitHub APIs

…nd show commands

Darrel (darrelmiller) · 2023-01-15T16:01:58Z

This PR now also fixes #1124 and #1127

…ill actually see it.

Because the issue was addressed

sonarqubecloud · 2023-01-16T22:49:08Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
8 Code Smells

82.5% Coverage
0.0% Duplication

Darrel (darrelmiller) requested review from Maggie Kimani (MaggieKimani1), Vincent Biret (baywet), Irvine Sunday (irvinesunday), Millicent Achieng (millicentachieng), Peter Ombwa (peombwa) and Mustafa Zengin (zengin) as code owners December 23, 2022 17:45

github-advanced-securityAI found potential problems Dec 23, 2022
View reviewed changes

Vincent Biret (baywet) requested changes Dec 23, 2022
View reviewed changes

github-advanced-securityAI found potential problems Dec 24, 2022
View reviewed changes

Comment threadsrc/Microsoft.OpenApi/Services/OpenApiUrlTreeNode.cs Fixed

Vincent Biret (baywet) requested changes Dec 28, 2022
View reviewed changes

Darrel (darrelmiller)and others added 11 commits January 3, 2023 17:15

Added show command
e517053

Moved mermaid writer into OpenApiUrlTreeNode and fixed more sanitizat…
49a12f3
…ion issues

Added shapes for better accessibility
8781884

Update to do a unnecessary using
0bc1726
Co-authored-by: Vincent Biret <vibiret@microsoft.com>

Update src/Microsoft.OpenApi/Services/OpenApiUrlTreeNode.cs
e8061ac
Co-authored-by: Vincent Biret <vibiret@microsoft.com>

Update src/Microsoft.OpenApi/Services/OpenApiUrlTreeNode.cs
5a7146c
Co-authored-by: Vincent Biret <vibiret@microsoft.com>

Added a bunch of usings and removed an unnecessary flush to address c…
fc3ba5e
…omments

Fixed broken order method
6c57e8d

Update src/Microsoft.OpenApi/Services/OpenApiUrlTreeNode.cs
9e2ff51
Co-authored-by: Vincent Biret <vibiret@microsoft.com>

Update src/Microsoft.OpenApi/Services/OpenApiUrlTreeNode.cs
efeeca7
Co-authored-by: Vincent Biret <vibiret@microsoft.com>

Update src/Microsoft.OpenApi/Services/OpenApiUrlTreeNode.cs
5d87820
Co-authored-by: Vincent Biret <vibiret@microsoft.com>

Darrel (darrelmiller)force-pushed the dm/show branch from ff54122 to 5d87820Compare January 3, 2023 22:18

Darrel (darrelmiller) added 3 commits January 3, 2023 17:57

Changed mermaid styles to make them readonly
674fe14

Fixed data in broken test
931270f

Updated public API
079da0f

Vincent Biret (baywet) previously approved these changes Jan 4, 2023
View reviewed changes

Darrel (darrelmiller) added 2 commits January 11, 2023 21:43

Change test to call sync invoke
776e98f

Added back missing parameter config options in parseopenapi
5bc0bd4

Vincent Biret (baywet) requested changes Jan 12, 2023
View reviewed changes

Comment threadsrc/Microsoft.OpenApi.Hidi/Program.cs Outdated

Darrel (darrelmiller) added 3 commits January 14, 2023 20:31

Updated SanitizeMermaidNode to handle cases found in Microsoft Graph …
5ee6095
…and GitHub APIs

Removed Task.Delay as no longer necessary.#1127
a7c4983

Updated commands to enable reading from CSDL url for both transform a…
7aac03f
…nd show commands

github-advanced-securityAI found potential problems Jan 15, 2023
View reviewed changes

Comment threadsrc/Microsoft.OpenApi.Hidi/OpenApiService.cs Fixed
Comment threadsrc/Microsoft.OpenApi.Hidi/OpenApiService.cs Fixed

Used random file in a hidi folder to address security concerns.
8e2d470

Darrel (darrelmiller) mentioned this pull request Jan 15, 2023
Bugfix #1124 When CSDL filter and http resource supplied for HIDI input, it fails because ApplyFilter expects a local file but not a URL address #1125
Closed

Darrel (darrelmiller) added 2 commits January 15, 2023 11:11

Fixed code smell relating to LogError
c23694c

Added test to call Transform command directly so that code coverage w…
6a3dd01
…ill actually see it.

Vincent Biret (baywet) previously requested changes Jan 16, 2023
View reviewed changes

Comment threadsrc/Microsoft.OpenApi/Services/OpenApiUrlTreeNode.cs
Comment threadsrc/Microsoft.OpenApi.Hidi/OpenApiService.cs Fixed

Vincent Biret (baywet) linked an issue Jan 16, 2023 that may be closed by this pull request
When CSDL filter and http resource supplied for HIDI input, it fails because ApplyFilter expects a local file but not a URL address #1124
Closed

Darrel (darrelmiller) added 7 commits January 16, 2023 13:18

Removed unnecessary test that was breaking
8ff70a1

This time I included the change
b95cda3

Added missing comments for public APIs
230af2f

Added more tests to meet the coverage gods
2b82a74

More sacrifices made
4537239

Will these be the tests that achieve the magical goal?
96fae88

I am confidence I have enough tests now
7638805

Added a using to dispose a StreamReader
a8a693d

Maggie Kimani (MaggieKimani1) approved these changes Jan 17, 2023
View reviewed changes

Vincent Biret (baywet) approved these changes Jan 17, 2023
View reviewed changes

Darrel (darrelmiller) merged commit 95e598b into vnextJan 17, 2023

Darrel (darrelmiller) deleted the dm/show branch January 17, 2023 15:05

Uh oh!

Conversation

Darrel (darrelmiller) commented Dec 23, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Check notice

Check notice

Vincent Biret (baywet) left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Darrel (darrelmiller) commented Dec 25, 2022

Uh oh!

Vincent Biret (baywet) commented Dec 28, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Darrel (darrelmiller) commented Jan 3, 2023

Uh oh!

Vincent Biret (baywet) left a comment

Choose a reason for hiding this comment

Uh oh!

Darrel (darrelmiller) commented Jan 4, 2023

Uh oh!

Darrel (darrelmiller) commented Jan 12, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Vincent Biret (baywet) commented Jan 12, 2023

Uh oh!

Uh oh!

Uh oh!

Darrel (darrelmiller) commented Jan 15, 2023

Uh oh!

Uh oh!

Uh oh!

sonarqubecloudBot commented Jan 16, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Darrel (darrelmiller) commented Dec 23, 2022•
edited
Loading

Darrel (darrelmiller) commented Jan 12, 2023•
edited
Loading