Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(acquisition): Proposal update for next version of API #2739

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(acquisition): Proposal update for next version of API #2739

wants to merge 1 commit into from

Conversation

hugobarthelemy
Copy link
Contributor

@hugobarthelemy hugobarthelemy commented Dec 20, 2024 •
edited
Loading

#fixes (issues)

Description

Ceci est une proposition de simplification de l'API trajet afin de réduire le nombre de champs retourner par l'API trajet:

  • de status+ fraud_error_labels + anomaly_error_details + terms_violation_details
  • à status + rejected_reasons

C'est bien entendu une proposition pour une prochaine mise à jour majeure et nécessitant vos contribution.

Checklist

Merge

🚨 Do not merge before change api-v3.1.yaml to api-vX.0.yml 🚨

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

Voir la convention de message de commit... 
<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

    • Updated API specifications to version 3.1, enhancing journey registration service functionality.
    • Introduced new enumerated values for journey submission status: accepted and rejected.
    • Added a new schema for rejected_reasons, improving clarity on rejection categories.

  • Documentation

    • Enhanced descriptions and examples for API components, improving usability for developers.
    • Refined error handling documentation, clarifying conditions for various error responses.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 20, 2024 •
edited
Loading

Walkthrough

The pull request updates the API specifications for the journey registration service from OpenAPI version 3.0.3 to 3.1. The changes focus on refining the API documentation, restructuring response schemas, and improving error handling. Key modifications include renaming terms_violation_labels to rejected_reasons, updating the status schema with new enumerated values like accepted and rejected, and removing several legacy schemas related to violation and anomaly labels.

Changes

File Change Summary
api/specs/api-v3.1.yaml - Updated OpenAPI version from 3.0.3 to 3.1
- Renamed terms_violation_labels to rejected_reasons
- Added new rejected_reasons schema
- Updated status schema with new enum values
- Removed terms_violation_details, terms_violation_label, fraudcheck_label, and anomaly_label schemas

Possibly related PRs

Suggested reviewers

  • jonathanfallon

Poem

🐰 API specs dance and twirl,
Schemas rename, new meanings unfurl
Rejected, accepted - status clear
Documentation now shines with cheer
Rabbit hops through code's new frontier! 🚀

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
🪧 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. (Beta)
  • @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.

coderabbitai[bot]
coderabbitai bot reviewed Dec 20, 2024
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
api/specs/api-v3.1.yaml (2)

1236-1322: LGTM! Well-structured rejection reasons with clear documentation.

The new rejected_reasons schema effectively consolidates error reporting while maintaining backward compatibility. The comprehensive documentation and logical grouping of reasons make the API more maintainable.

Consider adding deprecation notices with timeline for the labels marked with 📦:

  • terms_violation_error
  • fraud_error
  • anomaly_error
🧰 Tools
🪛 yamllint (1.35.1)

[error] 1250-1250: trailing spaces

(trailing-spaces)

[error] 1271-1271: trailing spaces

(trailing-spaces)

[error] 1306-1306: trailing spaces

(trailing-spaces)

[error] 1322-1322: trailing spaces

(trailing-spaces)

1250-1250: Fix trailing spaces in the YAML file.

There are trailing spaces on lines 1250, 1271, 1306, and 1322 that should be removed to maintain consistent formatting.

Also applies to: 1271-1271, 1306-1306, 1322-1322

🧰 Tools
🪛 yamllint (1.35.1)

[error] 1250-1250: trailing spaces

(trailing-spaces)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c0c631b and 322ee47.

📒 Files selected for processing (1)
  • api/specs/api-v3.1.yaml (3 hunks)
🧰 Additional context used
🪛 yamllint (1.35.1)
api/specs/api-v3.1.yaml

[error] 1250-1250: trailing spaces

(trailing-spaces)

[error] 1271-1271: trailing spaces

(trailing-spaces)

[error] 1306-1306: trailing spaces

(trailing-spaces)

[error] 1322-1322: trailing spaces

(trailing-spaces)

🔇 Additional comments (1)
api/specs/api-v3.1.yaml (1)

1226-1235: LGTM! Status enum simplification improves API clarity.

The simplified status enum with four clear states (pending, accepted, rejected, canceled) makes the API more intuitive and easier to understand. This change aligns well with the PR objective to simplify the API.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@hugobarthelemy