Schemas: pilot

Schemas whose first using operation belongs to the pilot family. A shared schema is described once, here, and linked from every operation that uses it.

Descriptions come from the contract, which is written in French. They are reproduced verbatim so that the contract remains the source of truth.

`AttestationIn`

Acte sur une etape : piece recue (reference) ou non-application (motif).

Type : object

Property	Type	Required	Constraints
`idempotency_key`	`string`	yes	minLength: 8 ; maxLength: 64
`kind`	`"completed" \| "not_applicable"`	yes
`reference`	`string \| null`	no	minLength: 3 ; maxLength: 80
`waiver`	`"assisted_entry_only" \| null`	no

Used by : pilotAttestStep

`AttestationOut`

Acte enregistre sur une etape.

Type : object

Property	Type	Required	Description	Constraints
`attested_at`	`string (date-time)`	yes
`attested_by`	`string (uuid)`	yes
`id`	`string (uuid)`	yes
`kind`	`"completed" \| "not_applicable"`	yes
`reference`	`string \| null`	yes
`replayed`	`boolean`	no	Vrai si la cle d'idempotence a rejoue un acte existant.	default: false
`waiver`	`"assisted_entry_only" \| null`	yes

Used by : pilotAttestStep, pilotJourney

`EngagementOut`

Ouverture du parcours.

Type : object

Property	Type	Required
`definition_version`	`integer`	yes
`id`	`string (uuid)`	yes
`opened_at`	`string (date-time)`	yes
`opened_by`	`string (uuid)`	yes

Used by : pilotJourney, pilotOpenEngagement

`MilestoneOut`

Jalon : atteint quand ses etapes obligatoires sont reglees. Aucun pourcentage.

Type : object

Property	Type	Required
`milestone`	`string`	yes
`reached`	`boolean`	yes
`required_settled`	`integer`	yes
`required_total`	`integer`	yes
`required_unavailable`	`integer`	yes

Used by : pilotJourney

`NextOut`

Maintenant, en attente de, a venir.

Type : object

Property	Type	Required
`now`	`array<string>`	yes
`upcoming`	`array<string>`	yes
`waiting_on`	`array<WaitingOut>`	yes

Used by : pilotJourney

`PilotEntitlementsOut`

Perimetre applique par CONTROL (dimension D), sans montant.

Type : object

Property	Type	Required
`dossier_cap`	`integer \| null`	yes
`ends_on`	`string (date) \| null`	yes
`modules`	`array<string>`	yes
`pilot`	`boolean`	yes
`revision`	`integer`	yes
`starts_on`	`string (date)`	yes

Used by : pilotJourney

`PilotJourneyOut`

Le parcours du pilote de l'institution, pour ce lecteur.

Type : object

Property	Type	Required
`definition_version`	`integer`	yes
`engagement`	`EngagementOut \| null`	yes
`entitlements`	`PilotEntitlementsOut \| null`	yes
`journey`	`string`	yes
`milestones`	`array<MilestoneOut>`	yes
`next`	`NextOut`	yes
`stage`	`"framework" \| "configured" \| "collecting" \| "dataset_frozen"`	yes
`steps`	`array<PilotStepOut>`	yes

Used by : pilotJourney

`PilotStepOut`

Etape du parcours, et ce qui fonde son etat.

Type : object

Property	Type	Required	Description
`actionable`	`boolean`	yes	Le lecteur detient la permission d'agir maintenant.
`approver`	`string \| null`	yes	Permission de la fonction qui approuve.
`attestation`	`AttestationOut \| null`	yes
`blockers`	`array<string>`	yes
`code`	`string`	yes
`completion`	`"computed" \| "attested" \| "unavailable"`	yes
`counts`	`map<string, integer> \| null`	yes	Comptes de l'etape ; `null` si le lecteur n'a pas la lecture du module.
`criterion_met`	`boolean`	yes
`milestone`	`string`	yes
`owner_module`	`string`	yes
`planned_slice`	`string \| null`	yes
`required`	`boolean`	yes
`responsible`	`string`	yes	Permission de la fonction qui agit.
`state`	`"blocked" \| "available" \| "in_progress" \| "awaiting_approval" \| "completed" \| "not_applicable" \| "unavailable"`	yes
`unavailable_reason`	`string \| null`	yes
`waivers`	`array<"assisted_entry_only">`	yes

Used by : pilotJourney

`WaitingOut`

Etape qui attend une autre fonction.

Type : object

Property	Type	Required	Description	Constraints
`permission`	`string`	yes
`step`	`string`	yes

Used by : pilotJourney