Feat: evol api

[nmrgt]

Features:

• operator_trip_id required
• journey must be sent in 24h

Summary by CodeRabbit

• New Features

  • Introduced a differenceInHours function for calculating hour differences between dates.
  • Added operator_trip_id as a required field in journey-related schemas and interfaces.

• Bug Fixes

  • Updated carpool acquisition status logic to dynamically reflect the time elapsed since creation.

• Documentation

  • Updated API specifications to include the new required operator_trip_id field.

• Style

  • Standardized string quotation marks in schema definitions.

[coderabbitai[bot]]

Walkthrough

The pull request introduces several changes across multiple files, enhancing date manipulation capabilities, modifying data structures, and updating API specifications. Key updates include the addition of a differenceInHours function for calculating time differences, the enforcement of required fields in data transfer objects, and the standardization of schema definitions. Additionally, dynamic timestamp values replace fixed dates in mock data, improving flexibility in testing scenarios.

Changes

File Path	Change Summary
api/src/deps.ts	Added export { difference } from Deno's datetime module.
api/src/lib/date/index.ts	Introduced differenceInHours(d1: Date, d2: Date): number function for hour calculations.
api/src/pdc/providers/carpool/mocks/database/carpool.ts	Updated start_datetime and end_datetime to dynamic values based on the current time.
api/src/pdc/providers/carpool/providers/CarpoolAcquisitionService.ts	Modified carpool status logic using differenceInHours to check if acquisition is expired.
api/src/shared/acquisition/common/interfaces/CreateJourneyDTO.ts	Changed operator_trip_id from optional to required.
api/src/shared/acquisition/common/schemas/createJourneySchemaV3.ts	Standardized quotation marks and added operator_trip_id as a required field.
doc/docs/.vuepress/public/specs/operateurs-api-v3.yaml	Added operator_trip_id to the required fields in the API specification schema.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant API
    participant CarpoolService
    participant DateLibrary

    User->>API: Request carpool acquisition
    API->>CarpoolService: Check carpool status
    CarpoolService->>DateLibrary: differenceInHours(created_at, start_datetime)
    DateLibrary-->>CarpoolService: Return hours difference
    CarpoolService-->>API: Return carpool status (Expired/Received)
    API-->>User: Respond with carpool status

Poem

🐇 In the meadow where the timestamps play,
A new function hops in, brightening the day.
With hours counted, and fields made right,
Our journeys now shine, oh what a sight!
Let's cheer for the code, as it leaps and bounds,
In the world of data, joy abounds! 🌼

---

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.