Skip to content

Incompatiable with OpenApi 3.0.1 #107

Open
@kulsingh0

Description

@kulsingh0

Brief Introduction:
We are facing issues while generating the sphinx documentation while using openAPI 3.0.1 yml template files .
But it works successful with the Swagger 2.0 template.

Ask:
Can you please confirm if sphinx supports OpenAPI 3.01 templates for documentation?

Problem Statement :
Specifically, we are facing issues for following parameters in documentation.
a) Request Json Parameters
b) Response Json Parameters

As per below example of Open API 3.01 template it expects
image
( schema property is child of content)

where as in Swagger 2.0 the structure looks like this.
image

if we use the Swagger 2.0 yml to generate the HTML documentation then I successfully generates the Request JSON Parameter and Response JSON Parameters as below.
image

where as with former with openAPI 3.0.1 template it failed to load these request Json parameter and response Json Parameters
image

You can refer any sample open API 3.0.1 template from internet to reproduce this issue.

Really appreciate your prompt support.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions