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 security scheme issues in Delivery API OpenAPI spec #17401

Merged
merged 1 commit into from
Nov 4, 2024

Conversation

kjac
Copy link
Contributor

@kjac kjac commented Oct 31, 2024

Prerequisites

  • I have added steps to test this contribution in the description below

If there's an existing issue for this PR then this fixes #17300

Description

The Delivery API OpenAPI spec wrongfully includes the back-office security scheme, because this is added to all OpenAPI specs by default.

This PR ensures that the Delivery API OpenAPI spec has no security scheme by default, but still allows for opting into the Umbraco member security scheme as per the docs.

The Umbraco member security scheme has been renamed from Umbraco Member to UmbracoMember, as whitespaces are not allowed in OpenAPI security scheme identifiers.

Testing this PR

  1. Verify that the Delivery API OpenAPI spec does not include any security schemes by default.
  2. Verify that it's possible to opt into the Umbraco member security scheme.
  3. For both of the above, use an OpenAPI schema validator (for example https://editor.swagger.io/ or https://validator.swagger.io/) to ensure the validity of the spec.
  4. Verify that this PR has no impact on the Management API OpenAPI spec.

@elit0451
Copy link
Member

elit0451 commented Nov 4, 2024

Works like a charm 💪 Merging 🔥

@elit0451 elit0451 merged commit 0505ff5 into release/15.0 Nov 4, 2024
16 checks passed
@elit0451 elit0451 deleted the v15/fix/delivery-api-security-scheme branch November 4, 2024 13:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants