Coder Social home page Coder Social logo

Comments (2)

char0n avatar char0n commented on June 18, 2024

Hi @calvin2021y,

A schema is used in multi location, each location could be used for different purposes. so add description to explain should be allowed.

I assume you're referring to the OpenAPI 3.0.x Reference Object. The OpenAPI specification is pretty clear about this:

This object cannot be extended with additional properties and any properties added SHALL be ignored.

You can bypass this limitation by using specification extension fields:

components:
  schemas: 
    schema1:
      type: object
      properties:
        prop1:
          $ref: "#/components/schemas/schema2
          x-description: description of the reference
    schema2:
      type: string  

OpenAPI 3.1.0, description and summary fields are allowed inside the Reference Object.

And for swagger 3.0.3, the type name is show at the location of $ref, this is very useful.
for https://editor-next.swagger.io/ with 3.1.0, I can not find type name from the location of $ref, this is confused.

This unfortunately I do not understand. Please reopen this issue with further elaboration or examples.

from swagger-editor.

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.