API contract for Todo app - #231
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Summary by CodeRabbit
WalkthroughThe pull request adds a new Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant API
Client->>API: GET /v1/tasks (pagination parameters)
API-->>Client: List of tasks with details
Client->>API: POST /v1/tasks (task data)
API-->>Client: Confirmation or error response
Client->>API: GET /v1/health
API-->>Client: Status response
Poem
🪧 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: 5
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
todo-backend/README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
todo-backend/README.md
[grammar] ~1-~1: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: # Todo Backend #### Task Object: ``` { i...
(TO_DO_HYPHEN)
🪛 markdownlint-cli2 (0.17.2)
todo-backend/README.md
3-3: Heading levels should only increment by one level at a time
Expected: h2; Actual: h4
(MD001, heading-increment)
3-3: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
5-5: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
31-31: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
33-33: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
45-45: Link fragments should be valid
null
(MD051, link-fragments)
46-46: Link fragments should be valid
null
(MD051, link-fragments)
47-47: Link fragments should be valid
null
(MD051, link-fragments)
64-64: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
119-119: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
159-159: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
208-208: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
222-222: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
225-225: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
251-251: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
260-260: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
|
@Achintya-Chatterjee I am merging this MR |
2 participants
Date: 04-Apr-2025
Developer Name: @VaibhavSingh8
Issue Ticket Number
N/A
Description
Added details of APIs present and being created in the form of API contract.
Documentation Updated?
Under Feature Flag
Database Changes
Breaking Changes
Development Tested?
Screenshots
Screenshot 1
Test Coverage
Screenshot 1
Additional Notes