Query parameters via hrefSchema

[echu]

Thanks for such a neat tool.

Not sure if this is the right place to ask the question, but I'm wondering if there's support for generating documentation that have query parameters. It's part of the json schema spec, but I'm not sure if you have plans to support it yet or if I've managed to do something wrong.

Thanks!

[handrews]

@echu it is definitely in plan- I'm the one who added hrefSchema to the spec!

Right now my focus is on reworking some of the internals to first better and more fully support draft-04, and then (much easier at that point) add draft-06 support. See ROADMAP.md for details.

There may be a simpler short-term way to add it if you have immediate need and can work on it. Let me know what your timeline is. It will likely be a few months before I get to draft-06 on my own.

[echu]

Haha, cool! I didn't quite realize handrews in the spec was you. Anyway, I'm not in a rush. Thanks, again.

[handrews]

As an update, I'm focused on getting JSON Hyper-Schema draft-07 out the door which includes more proposed functionality in this area, notably hrefPointers

I hope to then add full draft-07 support to the doca suite. I'm hoping that draft-07 will be pretty close to feature-complete for Hyper-Schema.

[handrews]

This set of packages is being deprecated in favor of the JSON Schema Tools monorepo. Contributions are still welcome here but most work will be done on the new packages.

The new UI is still being designed, but hopefully this should be handled in it. Feel free to file at cloudflare/json-schema-tools if you want to track this specifically.

[kadiocolzani]

Hi!

I'm starting a new project using doca and i still not understand how to add hrefSchema when generating documentation of my API. The JSON Schema Tools monorepo is not helping.

Thanks for the wonderful tool.

[handrews]

@kadiocolzani unfortunately the system is in a bit of an awkward state where there is a new back-end (JSON Schema Tools) but not yet a new front-end. I'm not sure if anyone at Cloudflare is actively working on a new front-end yet. @tajo, @tomlikestorock, or @zackproser might be able to comment. I am currently taking time away from the tech industry for personal reasons, but still working on the JSON Hyper-Schema specification and obviously still monitoring these repos.

The existing doca does not have hrefSchema support, and I doubt it will be added- the existing code is not set up well for that, which is why we created JSON Schema Tools for the next generation of Doca. I do still hope to see a new front-end as well.