top | item 41246088

(no title)

chacha102 | 1 year ago

This seems to be a fancy App/API surrounding Stoplight's Spectral library (https://docs.stoplight.io/docs/spectral/674b27b261c3c-overvi...), which is heavily relied upon (https://github.com/zuplo/rate-my-openapi/blob/main/apps/api/...) and not called out anywhere in the documentation.

When I originally looked at it, I assumed that there was going to be some collaboration or other form of discussion tool to help others navigate your spec file and provide feedback. As it is, it doesn't feel like its adding the much value.

discuss

order

molmorg|1 year ago

We'll update the docs to make our dependency on vacuum / spectral clearer - fair feedback. We do more than this though, we also use LLMs to help us identify other issues and recommend fixes.

RateMyOpenAPI is really designed as a quick litmus test to help people get their OpenAPI doc (and thus their documentation) in a good shape quickly, vs the hassle of setting up of individual rules.

People find it quite helpful to quickly build a todolist of things to do with their OpenAPI doc to get it into a much better state.