GithubHelp home page GithubHelp logo

Comments (6)

MarkHerhold avatar MarkHerhold commented on July 1, 2024 1

A second thought: Joi allows users to provide new types via Joi.extend(), so I see the potential for a lot of users to run into this same type of issue. Perhaps another approach would to allow users to provide "type resolvers" (think plugin) to j2s that way we push undefined behavior down to the user level. Thoughts?

from joi-to-swagger.

Twipped avatar Twipped commented on July 1, 2024

Swagger only allows for one data type per property, so support for joi.any() wasn't implementable. I'm not actually sure swagger has a way to define a forbidden property, short of omitting it and adding additionalProperties: false to the object definition.

If you can provide an example swagger output that would fit that that schema, then I can look into adding it.

from joi-to-swagger.

MarkHerhold avatar MarkHerhold commented on July 1, 2024

Good point about swagger output, but I think that throwing an unrecoverable error is probably not the best way to handle this as one field ruins the bunch.

My initial thought is that any could be represented as binary or any types could be left out/suppressed by default.

Would you accept a PR to suppress the any type from showing up in the schema and not throw an error (perhaps log a warning)?

from joi-to-swagger.

Twipped avatar Twipped commented on July 1, 2024

The plugin idea makes the most sense to me. I'll mull it over and see if I can come up with an api I like.

I would accept a PR to ignore any and not trigger an error, you can probably do it by just adding any: () => false to the parseAsType collection. It definitely should at least issue a warning (maybe via util.deprecate) if it's going to ignore the entry. Otherwise people wouldn't understand (and possibly not even notice) why it's absent.

from joi-to-swagger.

Makpoc avatar Makpoc commented on July 1, 2024

Sorry for the sort-of-necro-bump, but didn't want to open separate issue about topic, discussed here.

I looked around but didn't see any PRs related to the Joi.extend() issue, mentioned above. Was any progress made on that?

from joi-to-swagger.

Twipped avatar Twipped commented on July 1, 2024

Not really. The way I've addressed it in my own projects is to just explicitly define the swagger using the meta() override.

from joi-to-swagger.

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.