Api Lucca vNext

--- title: "Api Lucca vNext" tags: Api Lucca --- ---- Vue d'ensemble ```plantuml @startuml skinparam class { BackgroundColor White BorderColor Black ArrowColor Black } skinparam handwritten true FrenchSickLeave -left-|> Leave class FrenchSickLeave { bool Subrogation bool IsExtension bool IsEarlyReturn ... } Paternity --|> FrenchSickLeave class Paternity { bool Subrogation bool IsExtension bool IsEarlyReturn ... } class Leave { int Id Guid? BatchId LeaveType type int OwnerId int AccountId LeaveStatus Status date StartsOn DayPosition StartPosition date EndsOn DayPosition EndPosition Duration GetDuration() } Leave " " -right- "1" LeaveAccount class LeaveAccount { int Id string Name } Leave o-- "1..n" LeaveDay : Days class LeaveDay { date Date DayRange DayRange datetime? startsAt datetime? endsAt DurationUnit Unit* } LeaveApprovalRequest "0..1" --- "1..n" Leave class LeaveApprovalRequest { int Id int OwnerId int NextApproverId ApprovalState ApprovalState ... } LeaveCancellationRequest "0..n" --- "1" Leave class LeaveCancellationRequest { int Id int OwnerId int NextApproverId ApprovalState ApprovalState ... } @enduml ``` ---- Détail d'une leave ```plantuml @startuml skinparam class { BackgroundColor White BorderColor Black ArrowColor Black } skinparam handwritten true class Leave { int Id LeaveType type int OwnerId int AccountId LeaveStatus Status boolean HasCancellation date StartsOn DayPosition StartPosition date EndsOn DayPosition EndPosition Duration GetDuration() } Leave *-- "0..n" LeaveWarning : Warnings class LeaveWarning { string Code } Leave *-- "0..n" LeaveComment : Comments class LeaveComment { DateTime CreatedAt LeaveCommentType Type, string Message } enum LeaveCommentType { User Approving ... } @enduml ``` ---- ---- Events/Changes d'une leave Objectif de convergence avec le format des events envisagés pour les webhook cf. [RFC Lucca Webhooks](https://www.notion.so/RFC-Lucca-Webhooks-cff0e8efb5a6491a8af3c7fbf504fe97), pour fournir une api en conformité avec les webhooks envisagés. Liste des `Event types` gérés: - `leave.created` - `leave.confirmed` => ne provient pas d'une action directe sur la ressource (cf. RFC Workflow), mais parait le plus cohérent avec le changement d'état de la ressource. A discuter ? - `leave.deleted` => ps. action `delete` qui bascule la ressource dans l'état `cancelled` *sans préfixe: 'com.luccasoftware' ni '.alpha' ?* :warning: le changemet d'approche présente une évolution importante: la status n'est plus la seule mutation possible, toutes les infos descriptives le sont également: comments, attachments, ... Si on ne les expose pas, on se contente de `leave.confirmed`, sinon il faut se poser la question des autres `update` => `leave.updated` ? Gestion de l'`event data`: On connait à tout moment: - la représentation courante de la ressource => `data.resource` - sa version historisée au moment de l'événement => déduction possible des `data.updatedAttributes` ❔Est-ce qu'on expose un objet générique `Event` ? ❔Si oui, exposé à la racine avec un filtre sur le resourceType ? => Difficulté technique pour gérer n ressources différentes. `=>` on peut considérer une forme générique sur une API dédiée spécifique: schema `leave-event` sous l'url `/leaves/events` `=>` on peut assumer qu'une s'agit d'une sous-ressource spécifique. Constraints: - unicité garantie du couple (Leave.Id, Leave.EventType) Signature proposée sur la RFC: ``` class Event { string id string type string source string occurredAt string tenant array[string] scopes EventData data } class EventData { string type object resource object updatedAttributes } ``` Impacts sur l'API existante: - id ? On veut l'exposer en sachant qu'on expose pas le get unitaire ? ps. int en BD - eventType => type - source (/lucca-api/leaves) => inutile en contexte, on génère du bruit pour la conformité ? - eventDate => occurredAt - tenant => inutile en contexte - scopes => inutile en contexte - leave => data[type,resource,updatedAttributes:array[key,oldValue]] ? => leave: état de la ressource ? => quels champs requêtables ? query parameters: - since/until vs occurredSince/occurredUntil - leaveId ps. pour les events `confirmed` et `deleted`, on pourrait se contenter d'exposer le `status` parmi les `updatedAttributes`. ```plantuml @startuml skinparam class { BackgroundColor White BorderColor Black ArrowColor Black } skinparam handwritten true class LeaveEvent { } LeaveEvent -left-|> IEvent interface IEvent { int AuthorId { get; set; } DateTime EventDate { get; set; } string EventType { get; set; } } LeaveEvent "1" --> "1" Leave : ResourceData / Leave class Leave { Id } @enduml ``` ```yaml ``` ---- Les enums ```plantuml @startuml skinparam class { BackgroundColor White BorderColor Black ArrowColor Black } skinparam handwritten true enum DayPosition { FirstHalfOfDay SecondHalfOfDay } enum LeaveStatus { Pending Confirmed Cancelled } enum LeaveType { Standard FrenchSickLeave } enum DayRange { Morning Afternoon FullDay } enum DurationUnit { Days Hours } enum ApprovalState { Pending Approved Denied } @enduml ``` ---- Les FSL ```plantuml @startuml skinparam class { BackgroundColor White BorderColor Black ArrowColor Black } skinparam handwritten true class Leave { int Id LeaveType Type } FrenchSickLeave -left-|> Leave FrenchSickLeave "0..1" --- "1" FrenchSickLeave : OriginalSickLeave class FrenchSickLeave { FrenchSickLeaveNature? PartTimeNature bool HasSubrogation DateTime? SubrogationStartsOn DateTime? SubrogationEndsOn bool IsExtension bool IsEarlyReturn DateTime LastWorkingDay int NumberOfWaitingPeriodDays int NumberOfCompensatedDays PartTimeType PartTimeReturnType string Comments DateTime? AccidentDate string AccidentPlace DateTime? FirstObservationDate ChildArrivalType? ChildArrivalType bool IsSingleChild ChildAdoptionDistribution? DateTime? ChildArrivalScheduledDate DateTime? ChildArrivalEffectiveDate PaternityLeavePartType? PaternityLeavePartType decimal? CompensationRate decimal? PartTimeActivityRate bool? LongLastingAffection } @enduml ``` ---- Les enums de FSL ```plantuml @startuml skinparam class { BackgroundColor White BorderColor Black ArrowColor Black } skinparam handwritten true enum FrenchSickLeaveNature { Autre AccidentTravail AccidentTrajet Maladie MaladieProfessionnelle Maternite Paternite TempsPartielTherapeutique } enum PartTimeType { None Therapeutic PersonalReason } enum ChildArrivalType { Naissance Adoption } enum ChildAdoptionDistribution { MonoParental Duo } enum PaternityLeavePartType { PremierePartie PartieFractionnable } @enduml ``` ---- Les BR ```plantuml @startuml skinparam class { BackgroundColor White BorderColor Black ArrowColor Black } skinparam handwritten true class Leave { int Id LeaveStatus Status } Leave "1" --- "0..1" LeaveApprovalRequest : ApprovalRequest class LeaveApprovalRequest { int Id } Leave "1" --- "0..n" LeaveCancellationRequest : CancellationRequests LeaveCancellationRequest ..|> IWorkflowApprovable class LeaveCancellationRequest { int Id } LeaveApprovalRequest ..|> IWorkflowApprovable interface IWorkflowApprovable { WorkflowApprovalState ApprovalState int OwnerId int? NextApproverId int? NextTheoreticalApproverId int? CurrentStepNumber } IWorkflowApprovable "1" o-- "0..n" IWorkflowAction : WorkflowActions interface IWorkflowAction { int StepNumber string Comment WorkflowActionSource Source WorkflowActionType Type } IWorkflowApprovable "1" o-- "0..n" IApproval : Approvals IApproval ..|> IWorkflowAction interface IApproval { int ApproverId ApproverType ApproverType WorkflowApprovalMode Mode } IWorkflowApprovable "1" o-- "0..n" IDenial : Denials IDenial ..|> IWorkflowAction interface IDenial { int ApproverId ApproverType ApproverType WorkflowApprovalMode Mode } enum WorkflowApprovalMode { Manual Auto } enum ApproverType { Manager FiggoApprover Delegatee Transfered ... } enum WorkflowApprovalState { Pending Denied Approved } enum WorkflowActionSource { Desktop API Mobile Mail Migration } enum WorkflowActionType { Approval Denial Transfer Delegation SkippedApproval } @enduml ```

Syntax	Example	Reference
# Header	Header	基本排版
- Unordered List	Unordered List
1. Ordered List	Ordered List
- [ ] Todo List	Todo List
> Blockquote	Blockquote
Bold font	Bold font
Italics font	Italics font
~~Strikethrough~~	~~Strikethrough~~
19^th^	19^th
H~2~O	H₂O
++Inserted text++	Inserted text
==Marked text==	Marked text
[link text](https:// "title")	Link
![image alt](https:// "title")	Image
`Code`	`Code`	在筆記中貼入程式碼
```javascript var i = 0; ```	`var i = 0;`
:smile:		Emoji list
{%youtube youtube_id %}	Externals
$L^aT_eX$	L^aT_eX
:::info This is a alert area. :::	This is a alert area.