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

Merging to release-5.3: [TT-12814] Make schema more flexible, don't enforce additionalProperties: false (#6640) #6641

Conversation

buger
Copy link
Member

@buger buger commented Oct 15, 2024

User description

TT-12814 Make schema more flexible, don't enforce additionalProperties: false (#6640)

User description

TT-12814
Summary Make OAS JSON schema more flexible (do not enforce additionalProperties)
Type Bug Bug
Status In Dev
Points N/A
Labels -

https://tyktech.atlassian.net/browse/TT-12814


PR Type

Enhancement


Description

  • Removed additionalProperties: false from multiple object definitions
    in the JSON schema to enhance flexibility.
  • This change allows additional properties in the schema, making it more
    compatible and less strict.

Changes walkthrough 📝

Relevant files
Enhancement
x-tyk-api-gateway.json
Relax schema strictness by removing `additionalProperties: false`

apidef/oas/schema/x-tyk-api-gateway.json

  • Removed additionalProperties: false from multiple object definitions.
  • Enhanced flexibility of the JSON schema by allowing additional
    properties.
  • +1/-73   

    💡 PR-Agent usage: Comment /help "your question" on any pull
    request to receive relevant information

    Co-authored-by: Tit Petric tit@tyk.io


    PR Type

    Enhancement


    Description

    • Removed additionalProperties: false from multiple object definitions in the JSON schema to enhance flexibility.
    • This change allows additional properties in the schema, making it more compatible and less strict.

    Changes walkthrough 📝

    Relevant files
    Enhancement
    x-tyk-api-gateway.json
    Relax schema strictness by removing `additionalProperties: false`

    apidef/oas/schema/x-tyk-api-gateway.json

  • Removed additionalProperties: false from multiple object definitions.
  • Enhanced flexibility of the JSON schema by allowing additional
    properties.
  • +1/-72   

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link
    Contributor

    API Changes

    no api changes detected

    @titpetric titpetric force-pushed the merge/release-5.3/35500eee5146f3db0b0269ae5ae475774b7f4418 branch from 5ed743d to b4d81fb Compare October 15, 2024 13:05
    @titpetric titpetric marked this pull request as ready for review October 15, 2024 13:06
    @titpetric titpetric force-pushed the merge/release-5.3/35500eee5146f3db0b0269ae5ae475774b7f4418 branch from b4d81fb to 44b7a3c Compare October 15, 2024 13:06
    @titpetric titpetric enabled auto-merge (squash) October 15, 2024 13:06
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    🎫 Ticket compliance analysis ✅

    6640 - Fully compliant

    Fully compliant requirements:

    • Make OAS JSON schema more flexible
    • Do not enforce additionalProperties: false in the schema
    ⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Schema Validation
    Ensure that the removal of 'additionalProperties: false' does not introduce unintended side effects or security issues by allowing unexpected properties.

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Copy link

    @titpetric titpetric merged commit 5a5d23c into release-5.3 Oct 15, 2024
    37 of 39 checks passed
    @titpetric titpetric deleted the merge/release-5.3/35500eee5146f3db0b0269ae5ae475774b7f4418 branch October 15, 2024 13:20
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants