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

Limit interoperable parsing expectations (avoid type conflicts) #3732

Merged
merged 4 commits into from
Apr 25, 2024

Commits on Apr 21, 2024

  1. Limit interoperable parsing expectations

    As discovered through the OASComply project, certain referencing
    scenarios are ambiguous, with different authorities holding
    contradictory interpretations regarding whether and how they are
    to be supported.  As a result, it is impossible to define
    compliance, as all of the interpretations can be argued to be
    "correct" in some sense.
    
    This change excludes some particularly challenging scenarios from
    compliance testing by making their behavior explicitly
    implementation-defined.  This has several benefits:
    
    * No current implementation is rendered non-compliant
    * No currently usable OAD is rendered invalid
    * New implementers need not put effort into handling these scenarios
    * User expectations are set to _not_ expect consistent behavior
    * Linters can write a rule to match these expectations
    * Everyone is guided towards straightforwad best practices
    handrews committed Apr 21, 2024
    Configuration menu
    Copy the full SHA
    814e0d5 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    dd8c0aa View commit details
    Browse the repository at this point in the history

Commits on Apr 22, 2024

  1. Fix header level for new section

    The Structural Interoperability section should be a subsection
    of the OpenAPI Description Structure section.
    handrews committed Apr 22, 2024
    Configuration menu
    Copy the full SHA
    e2dd78c View commit details
    Browse the repository at this point in the history

Commits on Apr 25, 2024

  1. Substantially better wording from ralfhandl in review comments

    Co-authored-by: Ralf Handl <ralf.handl@sap.com>
    handrews and ralfhandl authored Apr 25, 2024
    Configuration menu
    Copy the full SHA
    ea38588 View commit details
    Browse the repository at this point in the history