[api] return 202 on successful CSR submit

[capcom6]

Summary by CodeRabbit

• Bug Fixes
  • Updated the API’s submission response to return a 202 Accepted status, clarifying that requests are queued for processing rather than marked as immediately completed.
• Documentation
  • Revised API documentation to reflect the change in response status from 200 OK to 202 Accepted for the /csr POST endpoint.

[coderabbitai]

Walkthrough

This pull request modifies the CSR processing endpoint in the API by updating the success HTTP response code in the submit method of the csrHandler. The response annotation and actual status setting have been updated from 200 (OK) to 202 (Accepted), indicating that the request has been accepted for processing but is not yet complete. The JSON payload and error handling mechanisms remain unchanged. Additionally, corresponding updates were made to the API documentation in Swagger files to reflect this change.

Changes

File	Change Summary
internal/api/csr.go	Updated the success status code annotation and response in the submit method from 200 to 202.
api/docs.go	Modified the Swagger documentation for the /csr endpoint to reflect the 202 response code.
api/swagger.json	Updated the response code for the POST method at the /csr endpoint from 200 to 202 in Swagger documentation.
api/swagger.yaml	Changed the response code for the POST method at the /csr endpoint from 200 to 202 in Swagger documentation.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant H as csrHandler
    C->>H: Submit CSR Request
    H-->>C: Return JSON response (HTTP 202 Accepted)

Loading

Tip

🌐 Web search-backed reviews and chat

• We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
• You can disable this feature by setting web_search: false in the knowledge_base settings.
• Please share any feedback in the Discord discussion.

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d544b20 and 224fea6.

📒 Files selected for processing (4)

• api/docs.go (1 hunks)
• api/swagger.json (1 hunks)
• api/swagger.yaml (1 hunks)
• internal/api/csr.go (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• internal/api/csr.go

🔇 Additional comments (3)

api/docs.go (1)

49-50: LGTM! The status code change aligns with best practices.

The change from 200 to 202 is appropriate since CSR processing is typically an asynchronous operation. The 202 Accepted status code correctly indicates that the request has been accepted but processing is not yet complete.

Let's verify that the handler implementation matches this documentation:

✅ Verification successful

🏁 Script executed:

#!/bin/bash
# Search for the CSR submit handler implementation
ast-grep --pattern 'func $_(c *fiber.Ctx) error {
  $$$
  return c.Status(fiber.StatusAccepted).$$$
}'

Length of output: 104

---

🏁 Script executed:

#!/bin/bash
# Let's search for any occurrence of fiber.StatusAccepted in the repository.
rg "return c\.Status\(fiber\.StatusAccepted\)" -n .

Length of output: 53

---

🏁 Script executed:

#!/bin/bash
# Search for any occurrence of 'fiber.StatusAccepted' in the repository.
rg "fiber\.StatusAccepted" -n .

Length of output: 90

---

🏁 Script executed:

#!/bin/bash
# Display the snippet around the CSR submit handler in internal/api/csr.go to verify the returned status.
sed -n '40,50p' internal/api/csr.go

Length of output: 253

---

CSR Submit Handler Verification: Status Code Correct

• The handler in internal/api/csr.go returns fiber.StatusAccepted (202), matching the documentation.
• The snippet confirms that the returned status code is indeed 202 Accepted as expected.

api/swagger.yaml (1)

101-102: LGTM! Documentation is consistent.

The YAML documentation correctly reflects the status code change to 202 Accepted.

api/swagger.json (1)

46-47: LGTM! Documentation is consistent.

The JSON documentation correctly reflects the status code change to 202 Accepted.

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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. (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.