Clarify Sandbox endpoint separation: Path vs Webhook #64081
Closed
+210
−4
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
{Clarify Sandbox endpoint separation: Path vs Webhook}
- 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.
Description
{Modularized patient-related endpoints into
PatientEndpoinService.cs
to clarify architectural separation between standard path routes and webhook routes usingPathItemTypeAttribute
. Attached a sample JSON output to illustrate how OpenAPI schema distinguishes these endpoints. }Fixes #{#64039} (in this specific format)
appDocument.json