Comments (4)
You can define an example
inside a schema. And yes, I believe that it's deprecated in favour of the outer examples
(not an array but an object, though).
from redocly-cli.
@tatomyr thank you so much! Appreciate your assistance 🙇♀️
from redocly-cli.
Hi @kdipippo, your indentation is wrong. The examples
keywords on lines 53 and 102 should have the same indentation as the corresponding schemas
. Hope this helps.
from redocly-cli.
@tatomyr ah! Thanks for the correction! I'm trying to wrap my head around how to pepper these examples. In the response format:
"200":
content:
application/json:
schema:
examples:
examples:
is at the same indent as schema:
. Does schema:
also allow for its own example inside? i.e.
"200":
content:
application/json:
schema:
type: object
properties:
example: # <---
examples:
Or is "schema" in here a different "schema" than what exists elsewhere? Media Type object lists that it itself has examples while the schema object inside the Media Type object also has example, but maybe the latter is deprecated in favor of the examples array on the outer object.
from redocly-cli.
Related Issues (20)
- Support internalFlagProperty as a list for remove-x-internal decorator HOT 2
- Update syntax for decorators to support markdown as well as file paths
- Support for operations that respond with `1xx` status codes HOT 5
- Incorrect command to preview local docs changes in contributing.md HOT 3
- Review guide for replacing servers list HOT 1
- redocly lint format html or markdown HOT 5
- better error handling when $ref references an external file in asyncapi HOT 7
- asyncapi lint support custom rules HOT 8
- Can't resolve remote $ref with query parameter HOT 3
- OAS 3.1 - arbitrary schema keywords are classified as lint errors HOT 3
- Missing const typing support HOT 2
- bug: inconsistent types for OAS3_1 schemas HOT 1
- Add some type of plugin to allow dynamic definition of extensions or config files HOT 2
- Support better means to set environment variables HOT 2
- dependentRequired is valid json schema but does not pass linting and prevents component from being available in UI. HOT 3
- Api HOT 2
- Add the `--ext` parameter to the `split` command HOT 1
- Running out of CPU inside of containers HOT 2
- join fails on commonly referenced components
- Redocly removing string for enums if there's non-numbers mixed in HOT 3
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 redocly-cli.