MAJ documentation technique

[jonathanfallon]

#fixes (issues)

Description

Checklist

• j'ai suivi les guidelines du "clean code"
• j'ai mis à jour la documentation technique
• ajout ou mise à jour des tests unitaires
• ajout ou mise à jour des tests d'intégration

Merge

Je squash la PR et vérifie que le message de commit utilise la convention d'Angular :

<type>(<scope>): <short summary>
  │       │             │
  │       │             └─⫸ Summary in present tense. Not capitalized. No period at the end.
  │       │
  │       └─⫸ Commit Scope: proxy|acquisition|export|...
  │
  └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test

Types de commit

• build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
• ci: Changes to our CI configuration files and scripts (examples: Github Actions)
• docs: Documentation only changes
• feat: A new feature (Minor bump)
• fix: A bug fix (Patch bump)
• perf: A code change that improves performance
• refactor: A code change that neither fixes a bug nor adds a feature
• test: Adding missing tests or correcting existing tests

Le scope (optionnel) précise le module ou le composant impacté par le commit.

Summary by CodeRabbit

• New Features

  • Introduced a collapsible section in the pull request template for commit message conventions.
  • Updated OpenAPI specification for the "Registre de preuve de covoiturage" API, enhancing response schemas and error handling.

• Bug Fixes

  • Improved error handling by changing the exception type for invalid operator IDs.

• Documentation

  • Refined API documentation for clarity and accuracy, including updates to descriptions and examples.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces several updates, including enhancements to the pull request template by adding a section for commit message conventions. This section includes a collapsible block detailing the structure and types of commits. Additionally, significant updates to the OpenAPI specification for the "Registre de preuve de covoiturage" API are made, including new response schemas and modifications to existing endpoints. Lastly, the getOperatorIdOrFail function's error handling is adjusted to throw a ForbiddenException instead of an UnauthorizedException.

Changes

File Path	Change Summary
.github/pull_request_template.md	Added a new section for commit message conventions with a collapsible details block outlining types.
api/specs/api-v3.1.yaml	Updated OpenAPI spec to version 3.1, added new response schemas, refined existing endpoints, and improved documentation clarity.
api/src/pdc/services/cee/helpers/getOperatorIdOrFail.ts	Modified error handling in getOperatorIdOrFail to throw ForbiddenException instead of UnauthorizedException.

Possibly related PRs

• Migration de la documentation technique #2711: The main PR introduces a new pull request template that includes guidelines for commit messages, which aligns with the changes made in the documentation for the pull request process in this PR.

Suggested reviewers

• P3rceval

🐰 In the code where we hop and play,
New templates guide us on our way.
With schemas bright and errors clear,
We code with joy, spreading cheer!
So let’s commit with style and grace,
In this rabbit hole, we find our place! 🐇

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a3be511 and 14d0af9.

📒 Files selected for processing (3)

• .github/pull_request_template.md (2 hunks)
• api/specs/api-v3.1.yaml (26 hunks)
• api/src/pdc/services/cee/helpers/getOperatorIdOrFail.ts (1 hunks)

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Experiment)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.