Where are Blueprint models documented?

[joshavant]

Hello,

I'm trying to develop some Blueprints for an Authentik deployment.

However, I really can't seem to find usable, comprehensive documentation of all Blueprint models and their attrs. Maybe I'm quite possibly overlooking something...

I did find the Blueprint schema here: https://version-2023-4.goauthentik.io/blueprints/schema.json

But, taking the example of the Blueprint model authentik_stages_prompt.promptstage...

...if I perform a Find for 'promptstage' in schema.json, I do find a big "enum" array seemingly listing all model keys. Ok, well, that's some kind of a start.

...but that's the only reference to the string promptstage in the whole document.

Where am I supposed to find this model has attrs of, e.g., name, fields, validation_policies, etc?

Am I looking at this wrong? Is there some type of tooling (a schema parser, etc) that I should be using to make sense of this? How are people implementing Blueprints with no documentation of the available Blueprint models + attrs?

[ImmanuelVonNeumann]

IDE Auto Completion

You can set the yaml-language-server to the schema-definition you found by adding

# yaml-language-server: $schema=https://goauthentik.io/blueprints/schema.json

to your yaml file.

This will allow your IDE to add suggestions based on the schema.

Exporing Schema

You can also go to https://goauthentik.io/blueprints/schema.json which lets you explore the schema.
Using the Search-Function I can see all available attributes: