GithubHelp home page GithubHelp logo

Swagger spec warning about request-baskets HOT 3 CLOSED

darklynx avatar darklynx commented on September 22, 2024
Swagger spec warning

from request-baskets.

Comments (3)

darklynx avatar darklynx commented on September 22, 2024

how did you get this warning / error message?
neither swagger-codegen nor js-yaml did not complain about YAML ...

can you also explain the reasons behind this error?

from request-baskets.

darklynx avatar darklynx commented on September 22, 2024

probably moving the description property into Headers definition object should be sufficient and will actually solve the warning, am I right?

according to this comment: swagger-api/swagger-js#402 (comment) if there is $ref there should be nothing else

from request-baskets.

IvanGoncharov avatar IvanGoncharov commented on September 22, 2024

how did you get this warning / error message?

I use Sway: https://github.com/apigee-127/sway/tree/master/docs#semantic-validation
But it has multiple problems including problems with release cycle.
So we started working on our own tool: https://github.com/APIs-guru/OpenAPI-Lint

according to this comment: swagger-api/swagger-js#402 (comment) if there is $ref there should be nothing else

It can be anything but it's should be overridden during resolution.

probably moving the description property into Headers definition object should be sufficient and will actually solve the warning, am I right?

Yes. Generic solution is allOf wrapper but in you case but your custom solution is better 👍

from request-baskets.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.