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

Clarify interoperable parsing expectations (3.0.4 port of #3732) #3772

Merged
merged 2 commits into from
May 22, 2024

Commits on May 16, 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
    
    Includes substantially better wording from ralfhandl from
    review comments for the 3.1.1 version of this change.
    
    Co-authored-by: Ralf Handl <ralf.handl@sap.com>
    handrews and ralfhandl committed May 16, 2024
    Configuration menu
    Copy the full SHA
    32c92aa View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    5573dc6 View commit details
    Browse the repository at this point in the history