Skip to content

Refactor task model#1

Open
infracore wants to merge 1 commit intomainfrom
break-the-api
Open

Refactor task model#1
infracore wants to merge 1 commit intomainfrom
break-the-api

Conversation

@infracore
Copy link
Copy Markdown
Member

Updates the task API model. Let's see what Delimit catches.

Changes:

  • Removed DELETE /api/tasks/{task_id} endpoint
  • Renamed assignee to assigned_to in Task model
  • Added required priority field to TaskCreate
  • Changed health endpoint uptime from integer to string

@github-actions
Copy link
Copy Markdown

🛡️ Breaking API Changes Detected

🔴 3 breaking changes · Semver: MAJOR · Next: 2.0.0

Count
Total changes 3
Breaking 3
Additive 0

Breaking Changes

Severity Change Location
🔴 Critical Method DELETE cannot be removed from /api/tasks/{task_id} /api/tasks/{task_id}:DELETE
📋 Migration guide

Migration Guide: TaskForge API (1.0.0 -> 2.0.0)

This release contains 3 breaking change(s).
Follow the steps below to update your integration.

Step 1: Method Removed

Change: Method removed: DELETE /api/tasks/{task_id}
Location: /api/tasks/{task_id}:DELETE

Action: Update clients using this HTTP method. Check if an alternative method is available on the same path.

Step 2: Required Field Added

Change: New required field 'priority' added at #/components/schemas/TaskCreate
Location: #/components/schemas/TaskCreate.priority

Action: If this is a request body field, include it in all requests. If this is a response field, update parsers to handle the new field.

Step 3: Required Field Added

Change: New required field 'priority' added at #/components/schemas/Task
Location: #/components/schemas/Task.priority

Action: If this is a request body field, include it in all requests. If this is a response field, update parsers to handle the new field.


After completing all steps, run your integration tests to verify.

Fix locally: npx delimit-cli lint


Powered by Delimit · Docs · Install

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant