Issues with OpenAPI Component Properties, Server Endpoints, and Path Filtering

[mdaneri]

Description:

The following issues were encountered in Pode:

1. New-PodeOAComponentSchemaProperty:

   • This function does not currently accept the following properties: $Example, $Deprecated, $Required, $Nullable, $ReadOnly, and $WriteOnly.
   • Expected Behavior: The function should support these properties to ensure complete OpenAPI schema descriptions.

2. Add-PodeOAServerEndpoint:

   • This function mistakenly accepts multiple local endpoints.
   • Expected Behavior: Only one local endpoint should be allowed for a single server definition.

3. OpenAPI Path Filtering:

   • OpenAPI path definitions that are outside the server endpoint URL should be excluded from the OpenAPI description.
   • Example:
     • Server Endpoint URL: /api/v3
     • Path 1: /api/v2/test
     • Path 2: /api/v3/test
   • Only paths that match the server endpoint (like path2) should be included in the OpenAPI description.

Steps to Reproduce:

1. Call New-PodeOAComponentSchemaProperty with the properties mentioned above and observe that they are not accepted.
2. Define multiple local endpoints using Add-PodeOAServerEndpoint and observe that more than one local endpoint is allowed.
3. Define paths with different API versions and note that paths outside the Server Endpoint URL are included in the OpenAPI description.

Expected Behavior:

• Support for missing properties in New-PodeOAComponentSchemaProperty.
• Restrict Add-PodeOAServerEndpoint to accept only one local endpoint.
• Exclude paths outside the Server Endpoint URL from the OpenAPI description.