Skip to content
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

Fix for OpenAPI Component Properties, Server Endpoint, and Path Filtering Issues #1420

Merged
merged 8 commits into from
Oct 21, 2024

Conversation

mdaneri
Copy link
Contributor

@mdaneri mdaneri commented Oct 15, 2024

Description:

This pull request addresses several issues related to the OpenAPI component schema properties, server endpoints, and path filtering. These changes are related to the issues raised in Issue #1419.

Changes made:

  1. Support for additional properties in New-PodeOAComponentSchemaProperty:

    • Added support for $Example, $Deprecated, $Required, $Nullable, $ReadOnly, and $WriteOnly properties, which were previously missing.
  2. Fix for Add-PodeOAServerEndpoint:

    • Updated the function to ensure that only one local endpoint can be defined. It was incorrectly accepting multiple local endpoints before this fix.
  3. Path Filtering for OpenAPI descriptions:

    • Updated the logic to filter out OpenAPI path definitions that do not match the server endpoint URL.
    • Example:
      • Server Endpoint URL: /api/v3
      • Paths such as /api/v2/test will now be excluded from the OpenAPI description, while valid paths like /api/v3/test will be retained.

Issue reference:

@mdaneri mdaneri changed the title Issue 1419 Fix for OpenAPI Component Properties, Server Endpoint, and Path Filtering Issues Oct 15, 2024
@Badgerati Badgerati added this to the 2.11.1 milestone Oct 20, 2024
Copy link
Owner

@Badgerati Badgerati left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Badgerati Badgerati merged commit 860aa58 into Badgerati:develop Oct 21, 2024
15 checks passed
@mdaneri mdaneri deleted the issue-1419 branch October 21, 2024 14:11
@Badgerati Badgerati mentioned this pull request Nov 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

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