docs(acquisition): Improve readability of GET journey #2733
Conversation
WalkthroughThis pull request updates the OpenAPI specification for the "Registre de preuve de covoiturage" API from version 3.0.3 to 3.1. The changes focus on enhancing API documentation, adding a new journey cancellation endpoint, updating status schemas, and improving error handling. The specification now provides more detailed information about API operations, with clearer descriptions, new enum values, and refined endpoint definitions to support better interaction and error management. Changes
Sequence DiagramsequenceDiagram
participant Operator
participant API
Operator->>API: POST /journeys/{operator_journey_id}/cancel
API-->>Operator: Return cancellation status
Note over API: Validate cancellation request
API->>Operator: Confirm journey cancellation
Possibly related PRs
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
api/specs/api-v3.1.yaml (1)
1247-1267: LGTM! The status values are now alphabetically ordered.The changes improve readability by:
- Organizing status values alphabetically
- Adding clear descriptions for each status
- Correctly documenting that
distance_too_shortis based on straight-line distanceConsider adding examples in the description to help API consumers better understand when each status might occur. For instance:
- `validation_error` : les données envoyées ne sont pas valides + Example: Missing required fields, invalid phone number format, etc.
Description
Précision de l'OpenAPI :
statusdu trajet : ordonnancement par ordre alphabétique pour les différentes listes afin que cela soit plus simple de vérifier la cohérence liste VS définitiondistance_too_short: précision que le calcule est fait à vol d'oiseau et non par résolution OSRM qui pourrait engendrer des incohérence entre le calcule réalisé par le RPC et celui fait par l'opérateur (tous les opérateurs n'utilisent pas forcément OSRM, pas forcément avec la même configuration, pas forcément la même version des maps etc...)Checklist
/api/specs[ ] ajout ou mise à jour des tests unitaires[ ] ajout ou mise à jour des tests d'intégrationMerge
Je squash la PR et vérifie que le message de commit utilise la convention d'Angular :
Voir la convention de message de commit...
Types de commit
Le scope (optionnel) précise le module ou le composant impacté par le commit.
Summary by CodeRabbit
New Features
Documentation