ArchAstro.V1.Config.Kinds (archastro v0.2.0)

Copy Markdown

Kind API resource.

Summary

Functions

list(client, params \\ %ArchAstro.Types.Operations.GetApiV1ConfigKinds.Params{})

List config kinds

Returns all config kinds registered in the platform, sorted alphabetically by name. Each entry describes a type of configuration object (e.g., "Agent", "APITool") and indicates whether a JSON schema and a YAML sample are available for it.

Any authenticated user may call this endpoint; no ownership scope is required. Pass one or more kind values to restrict the response to those specific kinds. Omit the parameter to receive the full list of non-private kinds.

Successful response

schema(client, kind)

Retrieve a config kind schema

Returns the JSON schema and a YAML sample for a single config kind. Use this to understand the structure a config object of that kind must follow before creating or validating one.

The json_schema field is null when the kind has no machine-readable schema defined. The sample_yaml field is null when no sample is available. Any authenticated user may call this endpoint; no ownership scope is required.

Returns 404 if the kind name does not match a registered, non-private config kind.

The JSON schema and YAML sample for the requested config kind.