docs.konghq.com icon indicating copy to clipboard operation
docs.konghq.com copied to clipboard

For DBless mode we need to have the schema documented.

Open rkazak opened this issue 2 years ago • 2 comments

Where is the problem?

https://docs.konghq.com/gateway/2.8.x/reference/db-less-and-declarative-config/

What happened?

There is no documented reference for the schema definition for Kong GW for either version 1.1 (as recognised by decK) or the version 2.1 (as recognised by Kong when used to do an initial setup of the Kong Gateway in DBLess mode.).

This leads to confusion when trying to create tooling to assist with setup and maintenance.

What did you expect to happen?

We should be able to see a reference for the 1.1 schema definition We should be able to see a reference for the 2.1 schema defnition We should have a change list, detailing the changes between these.

Code of Conduct and Community Expectations

  • [X] I agree to follow this project's Code of Conduct
  • [X] I agree to abide by the Community Expectations

rkazak avatar Jul 27 '22 15:07 rkazak

Does https://github.com/Kong/deck/blob/main/file/kong_json_schema.json help?

mheap avatar Jul 27 '22 16:07 mheap

@mheap Thanks for sharing the kong schema.

@rkazak In the past, I get the same issue in my first deployment, it's so hard to validate manifests. I include the schema on schema store: https://github.com/SchemaStore/schemastore/pull/2414, if my PR approval you could use that with vscode extension: redhat.vscode-yaml. I know it's don't resolve your issue but can help others.

EwertonJordao avatar Aug 13 '22 05:08 EwertonJordao