Skip to content
This repository has been archived by the owner on Dec 5, 2022. It is now read-only.

Update to Swagger 3.0 #160

Open
itpropro opened this issue Jul 6, 2019 · 1 comment
Open

Update to Swagger 3.0 #160

itpropro opened this issue Jul 6, 2019 · 1 comment

Comments

@itpropro
Copy link

itpropro commented Jul 6, 2019

I would like to use this theme as a documentation platform internally. The problem is that we internally as well as all our customers are using OpenAPI 3.0.

Expected Behavior

Use OpenAPI 3.0 yaml file as input for swagger_to_html and swagger_ui and see the redered UI/HTML on the website

Actual Behavior

Unhandled rejection Template render error: (unknown path)
SyntaxError: C:\repos\docs\source\swagger\example.yaml is not a valid Swagger API definition
...

Steps to Reproduce the Problem

  1. Create a working hexo instance by cloning the example repo
  2. Create a valid OpenAPI 3.0 file
  3. Create a new page and use the provided tag plugins to reference the example file

Specifications

  • NodeJS Version: v8.4.0
  • NPM Version: 6.10.0
  • OS: Windows 10 1903
  • Hexo Version: 3.9.0
@rbarilani
Copy link
Contributor

@itpropro For swagger-ui I think we should be able to have an easy fix, for the custom generator it's a little bit trickier since we have to update the way the we parse and transform the output to markdown/html (ping @bhaskarmelkani). @itpropro any chance that you contribute and help us out on this issue?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants