Skip to content

Commit

Permalink
add docs on confessio org/fr interface
Browse files Browse the repository at this point in the history
  • Loading branch information
etiennecallies committed Oct 13, 2024
1 parent 295b756 commit 1cb52ef
Showing 1 changed file with 80 additions and 0 deletions.
80 changes: 80 additions & 0 deletions docs/confessio_fr_org_interface.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
### Côté Confessio org (Nathan)
→ Prévoir l’authentification (HTTP)

→ endpoints pour récupérer les églises et paroisses

- [srvc-data] GET /dioceses
- *payload à définir*
- [srvc-data] GET /diocese/{id}
- *payload à définir*
- [srvc-data] GET /parish
- *payload à définir*

→ endpoints pour récupérer les jobs et update leur statut

- [scriptorium] GET / job/parsing
- renvoie null ou le payload du prochain job sur la queue (en statut “queued”)
- payload de réponse

```python
{
"job_id": str,
"parish_id": str,
"url": str,
"html": str
}
```

- [scriptorium] UPDATE / job/{id}
- payload

```python
{
"status": enum["started", "finished", "failed"]
}
```


→ endpoints pour ajouter les jobs et update leur statut

- [srvc-data] POST /schedules
- payload

```python
{
# Source
"job_id": uuid,

# What?
"type": enum["confession", "mass", "adoration", ...],
"description": Optional[str],
"status": enum["unpublished", "published"],

# When?
"start": datetime without timezone,
"end": Optional[datetime without timezone],

# Where?
"parish_id": uuid,
"church_id": Optional[uuid],
"appends_in_external_church": bool,
}
```

- [srvc-data] POST /schedules-rules
- *payload à définir*

### Côté [confessio.fr](http://confessio.fr) (Etienne)

→ récupère les paroisses et églises

→ dépile les job parsing

→ pousse les schedules

→ plus tard, exposer

- [srvc-data] GET /next-schedules
- input : une schedule_rule
- output : une list de schedules
- règles : *à préciser*

0 comments on commit 1cb52ef

Please sign in to comment.