Fix and Edit build time OpenAPI/ra/b

[Rick-Anderson]

Branch of #33359
Merges into #33359
Fixes #33391

---

Internal previews

📄 File	🔗 Preview link
aspnetcore/fundamentals/openapi/aspnetcore-openapi.md	Work with OpenAPI documents
aspnetcore/fundamentals/openapi/buildtime-openapi.md	Generate OpenAPI documents at build time

[Rick-Anderson]

@captainsafia this is just a quick edit. It likely has lots of error I'll find tomorrow. I do have a couple questions. Note this branch fixes all the build errors in your branch. This will merge into your branch so you should get credit for the commit to main.

[Rick-Anderson]

builder.Services.AddDefaults(); generates the error:
'IServiceCollection' does not contain a definition for 'AddDefaults'

[captainsafia]

This is my bad...I had trouble figuring out what would be a good illustration of a setup here.

Maybe we can do something that configures an EF Core DB context?

services.AddDbContext<MyContext>(options =>
                options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection")));

We'd have to add a definition for MyContext and the package references for EF

[Rick-Anderson]

@captainsafia @martincostello

This is my bad...I had trouble figuring out what would be a good illustration of a setup here.

Maybe we can do something that configures an EF Core DB context?

services.AddDbContext<MyContext>(options =>
                options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection")));

We'd have to add a definition for MyContext and the package references for EF

I have:

• Context
• package references for EF
• Connection string

[Rick-Anderson]

I don't see any connection string or sql info when //if (Assembly.GetEntryAssembly()?.GetName().Name != "GetDocument.Insider") is commented out. I don't see any difference in the generated OpenAPI file with or without the build check.

[captainsafia]

I don't see any connection string or sql info when //if (Assembly.GetEntryAssembly()?.GetName().Name != "GetDocument.Insider") is commented out

I believe this is because there isn't a connection string configured in the appsettings for this project. See changes in c86bab7.

I don't see any difference in the generated OpenAPI file with or without the build check.

In this case, that is the expected behavior. 👍🏽

[Rick-Anderson]

@captainsafia @martincostello
Any chance you could change the OpenApiGenerateDocumentsOptions to NOT use -- for options? I realize that's easier to parse and pass to the tool and -- is the standard for dotnet tools. The problem with -- is that you can't comment out those elements. If's frequently helpful to comment out elements. It's illegal XML and you get the following error:
Character sequence '--' is illegal inside XML comments.

[Rick-Anderson]

@captainsafia can you look this over and let me know what needs to change/delete before I can S&M it into your #33359? I'll then fix the merge conflicts in your #33359.