-
Notifications
You must be signed in to change notification settings - Fork 10.5k
Clarify Webhook vs Path Separation using Shared PathItemTypeAttribute #64088
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Thanks for your PR, @@nithyav2017. Someone from the team will get assigned to your PR shortly and we'll get it reviewed. |
@nithyav2017 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ), 1. Definitions. “Code” means the computer software code, whether in human-readable or machine-executable form, “Project” means any of the projects owned or managed by .NET Foundation and offered under a license “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any “Submission” means the Code and any other copyrightable material Submitted by You, including any 2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any 3. Originality of Work. You represent that each of Your Submissions is entirely Your 4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else 5. Licenses. a. Copyright License. You grant .NET Foundation, and those who receive the Submission directly b. Patent License. You grant .NET Foundation, and those who receive the Submission directly or c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. 6. Representations and Warranties. You represent that You are legally entitled to grant the above 7. Notice to .NET Foundation. You agree to notify .NET Foundation in writing of any facts or 8. Information about Submissions. You agree that contributions to Projects and information about 9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and 10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and .NET Foundation dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1. |
This PR replaces #64081 with a cleaner and corrected implementation.
-This change is scoped to the Sandbox project and does not affect runtime behavior or require tests.
- Endpoint separation is documented via
PathItemTypeAttribute
and modularized inPatientEndpointService
.- A sample JSON output document is attached to illustrate how standard path endpoints and webhook endpoints are distinguished in the OpenAPI schema.
> Note: When webhook endpoints are separated from standard paths using metadata like
PathItemType.Webhook
, they may not listed in tools like Postman that rely on conventional OpenAPI path discovery.-This PR addresses [Allow the OpenApiOperation be placed as a Paths or a Webhook #64039] by clarifying webhook or path routing in the sandbox.
Summary of the changes (Less than 80 chars)
Clarify endpoint separation using
PathItemType
metadata.Key Changes Compared to PR #64081
-Moved
PathItemTypeAttribute
andPathItemType
into a sharedServices/Metadata
folder to ensure consistent type identity-Updated all endpoint definitions to use the shared attribute
-Fixed OpenAPI generator logic to correctly classify webhook endpoints.
Description
Modularized patient-related endpoints into PatientEndpoinService.cs to clarify architectural separation between standard path routes and webhook routes using PathItemTypeAttribute. Attached a sample JSON output to illustrate how OpenAPI schema distinguishes these endpoint
Fixes #64039
appDocument.json