Management API OpenAPI document is not valid

[duuri-mollinen]

https://docs.lavinmq.com/http-api.html -> download -> https://editor.swagger.io ->

[dentarg]

Thanks for reporting @duuri-mollinen

Interesting, we do lint with https://github.com/stoplightio/spectral

lavinmq/build/build_docs_in_ci

Lines 5 to 9 in 9eab401

	echo "Linting HTTP API documentation"
	test -t 1 && USE_TTY="--tty" || true
	docker run --rm ${USE_TTY:-} -v $(pwd):/tmp stoplight/spectral:6 \
	--ruleset /tmp/openapi/.spectral.json \
	lint openapi/openapi.yaml

Maybe Spectral can't catch errors like these? Do you know if it is possible to lint with swagger-ui (or some other tool from the swagger project)? We would like to be able to run it command line.

The JSON you can download is provided by redoc-cli as part of the generated docs

lavinmq/Makefile

Lines 35 to 36 in 9eab401

	static/docs/index.html: openapi/openapi.yaml $(wildcard openapi/paths/*.yaml) $(wildcard openapi/schemas/*.yaml)
	npx redoc-cli build $< -o $@

but I checked the first error here and indeed items is missing here:

lavinmq/openapi/schemas/nodes.yaml

Lines 122 to 123 in 9eab401

	partitions:
	type: array

[duuri-mollinen]

That at least claims do the trick https://github.com/char0n/swagger-editor-validate I'm not sure about your tool chain, if that's directly suitable or not

[dentarg]

Thanks for that tip, I see it runs Swagger UI using Chrome headless via Puppeteer 😮 Not sure we want to go down that route, I'll need to do some research

[dentarg]

Tried https://github.com/APIDevTools/swagger-cli but it does not catch these errors

$ docker run -it --rm -v $(pwd):/app -w /app node:16 bash
...
root@53ddb7f05dac:/app# npm install -g @apidevtools/swagger-cli
...
root@53ddb7f05dac:/app# swagger-cli validate openapi/openapi.yaml
openapi/openapi.yaml is valid

Tried with too APIDevTools/swagger-cli#78 , didn't help

[dentarg]

This seems to be something at least (no line numbers given put those aren't really relevant anyway as the source is YAML), still an open question is how to produce the JSON in CI (and put it online?)

• https://validator.swagger.io/validator/debug?url=https://validator.swagger.io/validator/openapi.json outputs {"schemaValidationMessages":[]}
• https://validator.swagger.io/validator/debug?url=https://dentarg.net/tmp/cors/lavinmq_openapi.json outputs {"messages":["attribute components.schemas.node.items is missing","attribute components.schemas.shovels.items is missing","attribute components.schemas.federation-links.items is missing","attribute components.schemas.nodes_node.items is missing","attribute components.schemas.consumer_details.items is missing"],"schemaValidationMessages":[]}

[dentarg]

Looks like it is https://github.com/swagger-api/validator-badge that's powering https://validator.swagger.io/, possible to run using Docker