Skip to content

schemas_plugins_detail

GET
/api/schemas/plugins/{source}/{slug}
curl --request GET \
--url https://example.com/api/schemas/plugins/example/example \
--header 'Authorization: <Authorization>'

Retrieve a specific JSON schema from PluginRawSchema based on source, slug, and optional version.

slug
required
string
/^[^/]+$/
source
required
string
/^[^/]+$/
ref
boolean

Whether to keep references

version
string

Schema version to retrieve

Media typeapplication/json
object
key
additional properties

Example generated

{
"additionalProperty": "example"
}
Media typeapplication/json
object
code
required
string
>= 1 characters
message
required
string
>= 1 characters
details
required
Array<object>
object
parameter
string
nullable
code
string
nullable
message
string

Example

{
"code": "query_validation_error",
"message": "Invalid query parameters. Check the `details` property for more details.",
"details": [
{
"parameter": "source",
"code": "does_not_exist",
"message": "\"<source>\" does not exist"
}
]
}