Add PowerPlatformSpecGeneratorPlugin and configuration schema

[rwilson504]

Here is my initial draft for a Power Platform Plugin. It needs to be implemented better either through post processing or inheritance from the OpenAPI plugin but wanted to overriding the OpenAPI plugin to shows the differences between a normal OpenAPI file and a Power Platform formatted OpenAPI file. Will need some feedback.

• Implemented the PowerPlatformSpecGeneratorPlugin to generate OpenAPI specifications from recorded requests.
• Added configuration options including inclusion of OPTIONS requests, specification format (JSON/YAML), and contact/connector metadata.
• Created a JSON schema for validating the plugin's configuration settings.

#1183

[rwilson504]

@rwilson504 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@dotnet-policy-service agree [company="{your company}"]

Options:

• (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.

@dotnet-policy-service agree

• (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.

@dotnet-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ), and conveys certain license rights to the .NET Foundation ( “.NET Foundation” ) for Your contributions to .NET Foundation open source projects. This Agreement is effective as of the latest signature date below.

1. Definitions.

“Code” means the computer software code, whether in human-readable or machine-executable form, that is delivered by You to .NET Foundation under this Agreement.

“Project” means any of the projects owned or managed by .NET Foundation and offered under a license approved by the Open Source Initiative (www.opensource.org).

“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any Project, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of discussing and improving that Project, but excluding communication that is conspicuously marked or otherwise designated in writing by You as “Not a Submission.”

“Submission” means the Code and any other copyrightable material Submitted by You, including any associated comments and documentation.

2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any Project. This Agreement covers any and all Submissions that You, now or in the future (except as described in Section 4 below), Submit to any Project.

3. Originality of Work. You represent that each of Your Submissions is entirely Your original work. Should You wish to Submit materials that are not Your original work, You may Submit them separately to the Project if You (a) retain all copyright and license information that was in the materials as you received them, (b) in the description accompanying your Submission, include the phrase "Submission containing materials of a third party:" followed by the names of the third party and any licenses or other restrictions of which You are aware, and (c) follow any other instructions in the Project's written guidelines concerning Submissions.

4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your Submission is made in the course of Your work for an employer or Your employer has intellectual property rights in Your Submission by contract or applicable law, You must secure permission from Your employer to make the Submission before signing this Agreement. In that case, the term “You” in this Agreement will refer to You and the employer collectively. If You change employers in the future and desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement and secure permission from the new employer before Submitting those Submissions.

5. Licenses.

a. Copyright License. You grant .NET Foundation, and those who receive the Submission directly or indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third parties.

b. Patent License. You grant .NET Foundation, and those who receive the Submission directly or indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under Your patent claims that are necessarily infringed by the Submission or the combination of the Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and import or otherwise dispose of the Submission alone or with the Project.

c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above licenses. You represent that each of Your Submissions is entirely Your original work (except as You may have disclosed under Section 3 ). You represent that You have secured permission from Your employer to make the Submission in cases where Your Submission is made in the course of Your work for Your employer or Your employer has intellectual property rights in Your Submission by contract or applicable law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You have the necessary authority to bind the listed employer to the obligations contained in this Agreement. You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES EXPRESSLY STATED IN SECTIONS 3, 4, AND 6 , THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.

7. Notice to .NET Foundation. You agree to notify .NET Foundation in writing of any facts or circumstances of which You later become aware that would make Your representations in this Agreement inaccurate in any respect.

8. Information about Submissions. You agree that contributions to Projects and information about contributions may be maintained indefinitely and disclosed publicly, including Your name and other information that You submit with Your Submission.

9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County, Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all defenses of lack of personal jurisdiction and forum non-conveniens.

10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and supersedes any and all prior agreements, understandings or communications, written or oral, between the parties relating to the subject matter hereof. This Agreement may be assigned by .NET Foundation.

.NET Foundation dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1.

@dotnet-policy-service agree

[rwilson504]

@dotnet-policy-service agree

[waldekmastykarz]

Thanks for the PR! As we're still working on this, let me mark it as draft so that we don't merge it while it's still in progress

[waldekmastykarz]

Rather than duplicating the logic, we can build on top of the existing plugin and add post-processing of the generated spec. For example, we could add a new virtual method right before this line:

dev-proxy/dev-proxy-plugins/RequestLogs/OpenApiSpecGeneratorPlugin.cs

Line 132 in 4587a22

AddOrMergePathItem(openApiDocs, pathItem, request.Context.Session.HttpClient.Request.RequestUri, parametrizedPath);

Before we store the path item, we run some extra logic on it, and only then add it. Let's see if this is granular enough for our needs or if we'd need to introduce hooks further down the hierarchy.

For reference: we use a similar approach in the MockResponsePlugin where we have two virtual methods

dev-proxy/dev-proxy-plugins/Mocks/MockResponsePlugin.cs

Lines 294 to 308 in 4587a22

	protected virtual void ProcessMockResponse(ref byte[] body, IList<MockResponseHeader> headers, ProxyRequestArgs e, MockResponse? matchingResponse)
	{
	}
	protected virtual void ProcessMockResponse(ref string? body, IList<MockResponseHeader> headers, ProxyRequestArgs e, MockResponse? matchingResponse)
	{
	if (string.IsNullOrEmpty(body))
	{
	return;
	}
	var bytes = Encoding.UTF8.GetBytes(body);
	ProcessMockResponse(ref bytes, headers, e, matchingResponse);
	body = Encoding.UTF8.GetString(bytes);
	}

which we invoke in the process of mocking

dev-proxy/dev-proxy-plugins/Mocks/MockResponsePlugin.cs

Line 183 in 4587a22

ProcessMockResponseInternal(e, clonedResponse);

, and which we can override in other plugins such as https://github.com/dotnet/dev-proxy/blob/main/dev-proxy-plugins/Mocks/EntraMockResponsePlugin.cs to add extra logic on top of the base.

[rwilson504]

@waldekmastykarz I made updates based upon your suggestions.
This pull request introduces enhancements to the OpenApiSpecGeneratorPlugin and adds a new JSON schema for configuration validation. Key improvements include making the plugin extensible via virtual methods, refining path item processing, and defining a schema for plugin configuration.

Enhancements to OpenApiSpecGeneratorPlugin:

• Made OpenApiSpecGeneratorPlugin and its configuration class non-sealed to allow inheritance. (DevProxy.Plugins/Generation/OpenApiSpecGeneratorPlugin.cs, DevProxy.Plugins/Generation/OpenApiSpecGeneratorPlugin.csL53-R60)
• Introduced the ProcessPathItem method to allow derived plugins to customize OpenApiPathItem processing before merging it into the document. (DevProxy.Plugins/Generation/OpenApiSpecGeneratorPlugin.cs, [1] [2]
• Added the ProcessOpenApiDocument method to enable derived plugins to modify the OpenApiDocument before serialization. (DevProxy.Plugins/Generation/OpenApiSpecGeneratorPlugin.cs, [1] [2]

New JSON Schema for Configuration:

• Added powerplatformopenapispecgeneratorplugin.schema.json, defining a schema for plugin configuration, including fields like includeOptionsRequests, specFormat, includeResponseHeaders, and metadata properties such as contact and connectorMetadata. (schemas/v0.29.0/powerplatformopenapispecgeneratorplugin.schema.json, schemas/v0.29.0/powerplatformopenapispecgeneratorplugin.schema.jsonR1-R70)

[waldekmastykarz]

Cool @rwilson504! We'll review it asap

[Copilot]

Pull Request Overview

Initial draft for a Power Platform–specific OpenAPI spec generator plugin with a new JSON schema for configuration and extension hooks in the existing generator.

• Adds a JSON schema for validating PowerPlatformOpenApiSpecGeneratorPlugin settings
• Updates OpenApiSpecGeneratorPlugin to support post-processing hooks via virtual methods
• Adjusts class sealing to allow inheritance and customization

Reviewed Changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 3 comments.

File	Description
schemas/v0.29.0/powerplatformopenapispecgeneratorplugin.schema.json	Adds JSON schema for plugin configuration
DevProxy.Plugins/Generation/OpenApiSpecGeneratorPlugin.cs	Exposes ProcessPathItem/ProcessOpenApiDocument hooks and updates class sealing

Comments suppressed due to low confidence (1)

schemas/v0.29.0/powerplatformopenapispecgeneratorplugin.schema.json:24

• The description refers to "request headers" but the property name is "includeResponseHeaders." Update the description to reference response headers for consistency.

      "description": "Determines whether to include request headers in the generated OpenAPI spec. Default: false."

[Copilot]

The configuration class doesn't include properties for includeResponseHeaders, contact, and connectorMetadata, which are defined in the JSON schema. Add these properties so the plugin can bind the full configuration.

[waldekmastykarz]

Great start! Let's do a couple of adjustment. Specifically for prompts, let's evaluate how well they work with our default model. Here's some more information how you could do it: https://blog.mastykarz.nl/benchmark-models-openai-compatible-apis/

[waldekmastykarz]

Will this logic actually work? The default title that we pass is serverUrl API. If not specified, we fallback to API. How would an LLM be able to generate an API title from a string like API? A URL is more likely, but even then it might be a stretch for the generated string to match our requirements. Is there any other information that we could use to ensure we get closer to what we need?

[rwilson504]

For now I'm going to update this to set the serverUrl as the default. I'll think more on what other information I can pass to this.

[waldekmastykarz]

How is this different from GenerateParameterDescriptionAsync? Is the only difference the length? If so, I suggest that we create a method to get the description and then shorten to less than 80 chars.