Repository navigation
OAS 3.0: Rendering #3083
Description
This ticket tracks line items related to the rendering of OAS 3.0 specs. It does not include line items related to Try-It-Out functionality, or any UI changes to support the Editor experience.
Time estimates formatted as ##h/RiskLevel. Estimates include tests where applicable.
Work is being done in this branch.
TODO
Internal plumbing
- Add mechanism for overriding selectors based on spec content 8h/Med
(shockey@1f314dd) - Add mechanism for overriding components based on spec content 6h/Med (shockey@614c1ae and shockey@88848d0)
Supporting changes
- Render reorganized definitions (shockey@6093410#diff-be155ae7ebea3eda018b85efba94c8b0R41)
- Render reorganized responses 1h/Low
- Render reorganized parameters 2h/Low
- Support CommonMark in descriptions 1-2h/Low
- Render request bodies 4h/Low (Implemented, needs design work)
- Render cookie parameters 2h/Low
- Render response ranges 2h/Low
- Render callbacks 12h/Med
- Render
deprecated4h/Low - Render links 6h/Med
- Render media types in Request Parameters, Request Body, Responses 12h/Med
- Render schema values with
anyOf,oneOf,not10h/Med - Render nullables 1h/Low
- Render
writeOnly2h/Low
Moar changes
- Render
deprecatedin individual properties - Ensure Markdown XSS protections are still present in new renderer
Even moar changes (added 6/28)
- Disable validation badge
Ignoring deprecated fields
6h/Low in aggregate
- host
- basePath
- schemes
- consumes
- produces
- definitions
- parameters
- responses
Activity
shockey commentedon Jun 15, 2017
I moved this comment into the main ticket body.
webron commentedon Jun 21, 2017
Callbackstab should not appear if there are no callbacks defined.Linksstyling needs to be fixed.headersno longer exist under Links (this is from RC2)response content typeis aligned to the left and too close to theResponsestext, makes it look weird. But...response content typeshould appear individually per response code and no longer at the top of theResponses. Each response code can have entirely different content types defined for it.try it outfunctionality.shockey commentedon Jun 30, 2017
Status update on changes
Done:
Link headers have been annihilated.
Fixed:
Fixed:
Note the small lingering CSS issue inside the callback operation.
Done:
In progress - the functionality works, just need to finish guarding the code so it fails gracefully.
The two lingering Request Body fixes are tricky - the current implementations that provide the generated samples and editing interface are very opinionated about the incoming data (it expects Swagger 2.0 parameters) I have something in progress, but I'll have to wrap it up this weekend.
shockey commentedon Jul 4, 2017
@webron bump - need more info on
Links styling needs to be fixed