Get jsonschema for config file
GET /v1/general/config-schema
GET
/v1/general/config-schema
Return jsonschemas for Nuon configs. These can be used in frontmatter in most editors that have a TOML LSP (such as Taplo configured.
#:schema https://api.nuon.co/v1/general/config-schema?source=inputs
description = "description"
You can pass in a valid source argument to render within a specific source file:
- input
- installer
- sandbox
- runner
- docker_build
- container_image
- helm
- terraform
- job
By default, the config expects that you are using multiple files and sources. If you are not, then pass the
?flat=true param.
Parameters
Query Parameters
source
string
Return a schema for a source file
flat
string
Return a flat schema for the full app
Responses
200
OK
object
400
Bad Request
object
description
string
error
string
user_error
boolean
401
Unauthorized
object
description
string
error
string
user_error
boolean
403
Forbidden
object
description
string
error
string
user_error
boolean
404
Not Found
object
description
string
error
string
user_error
boolean
500
Internal Server Error
object
description
string
error
string
user_error
boolean