redocly / swagger-repo Goto Github PK
View Code? Open in Web Editor NEWCLI tool to help you manage your OpenAPI(fka Swagger) repo.
License: MIT License
CLI tool to help you manage your OpenAPI(fka Swagger) repo.
License: MIT License
I just started using Rebilly/generator-openapi-repo (you guys have done a great job!) and noticed that paths are loaded in alphabetical order. Is there any way we could customize that order?
I am using swagger-repo for one of my projects and GitHub is notifying me about security vulnerability in ws:
Error is shown in console when browsing /swagger-editor:
Refused to apply style from 'http://localhost:8080/swagger-editor.css' because its MIME type ('text/html') is not a supported stylesheet MIME type, and strict MIME checking is enabled.
swagger-editor:43 GET http://localhost:8080/swagger-editor-bundle.js net::ERR_ABORTED 404 (Not Found)
swagger-editor:44 GET http://localhost:8080/swagger-editor-standalone-preset.js net::ERR_ABORTED 404 (Not Found)
swagger-editor:82 Uncaught ReferenceError: SwaggerEditorBundle is not defined
at window.onload (swagger-editor:82)
It appears that some of the files are not being served and MIME type of css file is incorrect.
Hi
Thanks for this excellent project that you have open sourced.
i would like to use it and extend it for a tool that I am building.
In your index.js file the swaggerEditorMiddleware part has skipPlugins: true
Is there a way to override this?
Could you allow for some configuration here.
Thanks
Anshuman Das
I was getting this error:
TypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string. Received type undefined
In this new version the Path join is using the options basedir (in this line (209f827#diff-6d186b954a58d5bb740f73d84fe39073R306)) which is not the default command "build": "swagger-repo build -o web_deploy"
To make it run must use the -b option. Like this
swagger-repo build -o web_deploy -b spec
I need to hide some endpoints which are only for internal use. How can I do that?
I tried adding plugin and registered it with redocly.yaml but it is not working
Here is my redocly.yaml
# See https://redoc.ly/docs/cli/configuration/ for more information. apiDefinitions: main: openapi/openapi.yaml lint: extends: - recommended plugins: - './plugins/hider-plugin.js' decorators: hider/remove-internal-operations: error referenceDocs: htmlTemplate: ./docs/index.html theme: colors: primary: main: "red"
Seems like .
can not be use in PATH
.
For example:
'/users/{username}'
is defined in a filename: users@{username}.yaml
But if we want to have users.whatever/{username}
I dont know anyway to defined it correctly.
If the filename is users.whatever@{username}.yaml
it will fail with:
> swagger-repo validate
Validating definition...
Failed OpenAPI3 schema validation:
undefined:
1) #/ should be object but got undefined
Hello and thanks for all the hard work on this!
I'm curious why the build validates if all the code samples are either in the swagger.yml or in separate files? What was the motivation behind adding this check (the commit which added it didn't help: 32701eb)
Could we define a precedence, e.g. code samples defined in files override those defined in the spec file, and then just merge them?
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.