Giter VIP home page Giter VIP logo

openapi-jsdoc's People

Contributors

asznee7 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

openapi-jsdoc's Issues

Not possible to add vendor extensions

I haven't looked into this a ton yet. But I can't seem to figure out how to get vendor extensions into the final generated specification.

So far I've tried adding a custom entry to the definitions object. But in this case it seems like the specification does not show up in the final spec at all.

{
  "definition": {
    "info": {},
    "x-tagGroups": [
      {
        "name": "General",
        "tags": [
          "items"
        ]
      }
    ]
  },
  "apis": []
}

Or by adding an @openapi JSDoc comment with the extension in it. In this case it shows up under paths, which isn't where it is supposed to go.

/**
 * @openapi
 * x-tagGroups:
 *   - name: General
 *     tags:
 *       - items
 *   - name: Models
 *     tags:
 *       - item_model
 */

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.