ListAiRitualPresetsResponse

Shape

• itemsarray of AiRitualPresetThe presets.

  • The AiRitualPreset schema
  • descriptionstringWhat it holds, in a sentence.
  • keystringThe preset's key.
  • namestringIts name.
  • needs_cyclebooleanWhether it needs the organization's cycle cadence (calendar.cycle_cadence).
  • ritualsarray of RitualConfigIts rituals.

    • The RitualConfig schema
    • cadenceRitualCadenceWhen it runs.
    • keyRitualKey (string)The key the revision names the ritual by.
    • kindRitualKindstand_upplanningrefinementreviewretrospectivearchitecture_reviewreleasereplenishmentdigestWhat the ritual does.
    • nameRitualName (string)The organization's word for it.
    • scopeRitualScopeWhom it is for.
    • budget_microsinteger · int64 or nulloptional0–∞The most one run may spend, in millionths of a dollar; $5 when absent. A run reaching it ends early and applies nothing it had not finished.
    • facilitatorRitualFacilitator or nulloptionalWho runs it and writes its outcome; the kind's when absent.
    • outputsarray of RitualOutput: one of digest | assignments | cycle_selection | revision_proposal | decision_record | questions or nulloptionalWhat a run may produce, within what the kind allows; all of it when absent.
    • participantsarray of Position: one of engineer | reviewer | product_owner | director | release_manager | technical_writer or nulloptionalThe positions that contribute before the facilitator writes; the kind's when absent.
    • peopleRitualPeopleoptionalWhat people do in it.
    • skip_whenSkipWhennevernothing_changedor nulloptionalWhen a run is skipped without calling a model; the kind's when absent.
    • timeboxRitualTimebox or nulloptionalHow many turns a run's sessions may take; the kind's when absent.

      • The RitualTimebox schema
      • facilitator_turnsinteger · int320–∞Turns the facilitator's session may take.
      • participant_turnsinteger · int320–∞Turns each participant's session may take; 0 means the facilitator writes alone.

Graph

Used by