openapi.tools
openapi.tools copied to clipboard
apisyouwonthate
Add JSON schema spell and sensitivity checkers
I am not sure if these are in the right category. I'd love some recommendations on this.
Thanks @cbetta. I have to ask first, is it OpenAPI or JSON Schema? They're not the same thing. OpenAPI has a Schema Object "based" on JSON Schema, but they are not interchangeable. Not yet anyway (https://github.com/OAI/OpenAPI-Specification/pull/1977).
Same question to @mheap.
Ah, good point. I think the answer is "both and more". This tool isn't really specific to either and instead can be used to validate any fields in an object that can be addressed using a JSON Path.
This tool might be better named json-spell-checker to avoid confusion then? It could be cool to then leverage that tool with a thin layer which just points it at known OpenAPI fields like summary, description, etc and maybe even try spell checking enums as an option, etc. I'd rather not have generic JSON tooling on here even if it is useful for OpenAPI people, otherwise there's a lot of stuff which could appear on here.
Sure.
As for the name: I based the name on @mheap's original project. Maybe we should change the name if we know it will get merged in with a new name.
As for listing generic JSON tools: I see the point yet I would like to point out that @matthewtrask requested these tools to be added to this list 😆.
https://twitter.com/matthewtrask/status/1205135699256762369
Let me know if you think it's worth listing these libraries if we'd change the name or not.
Yes, if then name was json-spell-checker I'd merge it.
Bonus points if you make openapi-spell-checker which implements spell checking in all the places OpenAPI needs it (and can even handle markdown in places where OpenAPI handles markdown.
I'll take either but I think the combo is the most useful! :D
@mheap as a comprimise to get this old old PR over the line, could you merge a few of those dependabot PRs and tag a release, then I'll be happy to merge this PR as is.