Giter Club home page Giter Club logo

Comments (1)

handrews avatar handrews commented on June 2, 2024

What you are seeing is a limitation in OAS 3.0 and earlier.

In OAS 3.1, $ref in Schema Objects can have adjacent properties in accordance with the rules of draft 2020-12. For validation keywords, this is just the same as using an allOf. For annotation keywords like description, deprecated, readOnly, etc., it is up to the application (e.g. Swagger) to decide how to handle the adjacent keywords. They are not necessarily overwrites as not all annotations have the same semantics.

Also in OAS 3.1, $ref in the Reference Object allows exactly two adjacent keywords: summary and description. These are overwrites (unlike in the Schema Object).

Since OAS 3.1 has already addressed this issue, I'm going to close it. For Schema Objects, if you want different behavior from what OAS 3.1 does, you need to file that with JSON Schema as 3.1 just uses standard JSON Schema (unlike 3.0). For Reference Objects, if you want additional adjacent keyword support, please file a specific issue for that.

from openapi-specification.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.