TykTechnologies / tyk

Tyk Open Source API Gateway written in Go, supporting REST, GraphQL, TCP and gRPC protocols
Other
9.76k stars 1.09k forks source link

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

Closed buger closed 1 month ago

buger commented 1 month ago

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


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


    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

    github-actions[bot] commented 1 month ago

    API Changes

    no api changes detected
    github-actions[bot] commented 1 month ago

    PR Reviewer Guide πŸ”

    Here are some key observations to aid the review process:

    **🎫 Ticket compliance analysis βœ…** **[6640](https://github.com/TykTechnologies/tyk/issues/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.
    github-actions[bot] commented 1 month ago

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    sonarcloud[bot] commented 1 month ago

    Quality Gate Passed Quality Gate passed

    Issues
    0 New issues
    0 Accepted issues

    Measures
    0 Security Hotspots
    0.0% Coverage on New Code
    0.0% Duplication on New Code

    See analysis details on SonarCloud