OPENAPI-SPEC-VALIDATOR(1)

πŸ“¦ version 0.7.1, in debian trixie, ubuntu resolute, ubuntu stonking

πŸ’– OPENAPI-SPEC-VALIDATOR πŸ’–

okay so bestie, welcome to the manual for openapi-spec-validator β€” she's the girl who checks your OpenAPI specs against the 2.0, 3.0 and 3.1 standards. yes she is that girl. she is the girl. πŸŽ€


✨ NAME ✨

openapi-spec-validator β€” Validates OpenAPI Specs against 2.0, 3.0 and 3.1 standards. no cap, that's literally her whole job and she eats every single time. πŸ’…


🌸 DESCRIPTION 🌸

so here's the vibe, the whole entire usage situation:

usage: openapi-spec-validator [-h] [--errors {best-match,all}]

[--schema {detect,2.0,3.0,3.1}]
       file [file ...]

she takes your files, she looks at them with her little eyes, and she tells you if your spec is serving or if it's giving chaos. πŸ¦‹


🌈 positional arguments:

  • file β€” Validate specified file(s). yes plural, you can hand her a whole lil stack of files and she will handle them one by one, icon behaviour honestly. ✨

πŸ‘‘ options:

  • -h, --help β€” show this help message and exit. the classic. when in doubt, ask for help, she's not gonna judge you (she might a little). 🫢
  • --errors {best-match,all} β€” Control error reporting. Defaults to "best-match", so if you don't say anything she picks the single most relevant error for you like a considerate queen. use "all" to get all subschema errors β€” every single one, no crumbs left behind, the full drama, the entire group chat receipts. 😭
  • --schema {detect,2.0,3.0,3.1} β€” OpenAPI schema version (default: detect). she'll sniff out which version you're on by herself unless you tell her straight up. main character energy fr fr. πŸ’œ

lowkey reminder bestie: leave --errors alone and you get "best-match". that's the default. don't come for me, that's just what the manpage says. 🌸

πŸ’– SEE YA πŸ’–

that's the whole page, you're all caught up, go validate something and slay. πŸ’…βœ¨

openapi-spec-validator 0.7.1 β€” November 2024 πŸŽ€ she's been that girl since November 2024 and she's not stopping. bye bestie, mwah. πŸ«ΆπŸ¦‹

πŸ“¦ where this page comes from