Comments (2)
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)
- Provide a way to optionally not send a request body if optional
- Update the version of the generated Dart code
- Validation error thrown when $ref used in the description field. HOT 3
- How to get a list of the current validation errors?
- SwaggerEditor@next: Integrate [email protected] & release HOT 4
- Use proper version of @asyncapi/react-component HOT 1
- SwaggerEditor@next: Integrate latest VSCode + Monaco Editor versions HOT 2
- SwaggerEditor@next: Initial AsyncAPI 3.0.0 support HOT 1
- SwaggerEditor@next: add initial support for AsyncAPI 3.x HOT 2
- SwaggerEditor@next: provide AsyncAPI 3.x Petstore fixture HOT 2
- SwaggerEditor@next: provide AsyncAPI 3.x Streetslights fixture HOT 1
- Could not resolve dependency [email protected] HOT 1
- type: mutualTLS not supported in swagger editor HOT 1
- Freshly pulled swagger-editor@next is missing react-scripts HOT 1
- SwaggerEditor@next: avoid creating two monaco editor instances HOT 1
- SwaggerEditor@next: adapter to [email protected] HOT 1
- SwaggerEditor@next: readonly mode set via prop override HOT 1
- Swagger-Editor 4.12.1 failure when using latest swagger-ui (5.17.2) as a local dependency HOT 2
- SwaggerEditor@next: passing the configuration to AsyncAPI plugin HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from swagger-editor.