Comments (6)
@monica-m-ps
this is similar to your last post #2431
The oneOf
and description
are siblings and are not allowed in OAS 3.0.x. If you want to use both properties you need to modify the schema to use allOf
to encapsulate them.
customerEmail:
nullable: true
allOf:
- oneOf:
- $ref: ./PaymentIntentConfigCustomerEmail.yaml
- description:
$ref: ../../../prose/parameters/customerEmail.md
from redoc.
Hello @monica-m-ps,
I noticed that within the snippets provided, two properties customerEmail
and collectionRequired
have descriptions matching what's shown in the screenshots. I have also noticed that the paymentIntentConfigCustomerEmail
schema lacks a description in both the snippet and the screenshot.
Based on this, could you please specify which description exactly is missing after the file is downloaded? If there's publicly accessible documentation showcasing this issue, could you kindly provide a link to it?
from redoc.
@monica-m-ps can this be closed?
from redoc.
Yes please. Sorry there are still discussions going on within the team here.
@romanpryshliak : This is currently live on docs.dojo.tech/api.
@jeremyfiel Thanks for this solution. If I'll need to ask anything else, I'll post it again. Thank you!
from redoc.
@monica-m-ps Are you still having some issue with the description populating? I don't see it on the link you provided.
I think I misunderstood your usage of oneOf
. You should be able to get the description without the oneOf
.
customerEmail:
nullable: true
allOf:
- $ref: ./PaymentIntentConfigCustomerEmail.yaml
- description:
$ref: ../../../prose/parameters/customerEmail.md
from redoc.
Descriptions populated are fine. When you download the JSON, that's when some descriptions appear to be empty.
from redoc.
Related Issues (20)
- The v2.1.4 defines jest-environment-jsdom as prod dependency HOT 1
- Display conditional application of subschemas through the use of dependentRequired
- Redocly website blocks access to API documentation HOT 1
- This search cannot be used properly HOT 1
- Redocly mangles some property names HOT 3
- The field "Upload File" doesn´t show HOT 2
- minLength/maxLength not shown for array items with pattern HOT 1
- Disable "Response samples" section HOT 1
- Highlighting for request/response sample/example strings ignores content media type (always JSON highlighting) HOT 1
- Possible XSS issue on https://redocly.github.io/redoc/ HOT 4
- Building docs produces lots of warnings HOT 4
- Using @param annotation with body causes redoc rendering to fail
- Property `htmlTemplate` is not expected here. HOT 5
- Feature Request: Implementation of Arazzo Specification v1.0.0
- Change height of x-logo in yaml HOT 4
- Callbacks should have id attributes to allow linking to them
- showExtension option on array of strings does not show extensions
- HTML rendering broken / unusable when allOf and oneOf even if spec is considered 0 warning HOT 6
- Build-Docs OneOf Example HOT 4
- Show all components in the UI HOT 1
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 redoc.