Skip to content

Latest commit

 

History

History
148 lines (129 loc) · 4 KB

Api.md

File metadata and controls

148 lines (129 loc) · 4 KB

Migrate Script

dotnet ef migrations add InitialCreate -p SearchBugs.Persistence -s SearchBugs.Api

User Management Domain

Endpoints:

  1. Create User:
    • POST /api/users
  2. Get User Details:
    • GET /api/users/{user_id}
  3. Update User:
    • PUT /api/users/{user_id}
  4. Delete User:
    • DELETE /api/users/{user_id}
  5. Authenticate User:
    • POST /api/auth/login
  6. Logout User:
    • POST /api/auth/logout
  7. Get All Users:
    • GET /api/users

Project Management Domain

Endpoints:

  1. Create Project:
    • POST /api/projects
  2. Get Project Details:
    • GET /api/projects/{project_id}
  3. Update Project:
    • PUT /api/projects/{project_id}
  4. Delete Project:
    • DELETE /api/projects/{project_id}
  5. Get All Projects:
    • GET /api/projects

Bug Tracking Domain

Endpoints:

  1. Create Bug:
    • POST /api/bugs
  2. Get Bug Details:
    • GET /api/bugs/{bug_id}
  3. Update Bug:
    • PUT /api/bugs/{bug_id}
  4. Delete Bug:
    • DELETE /api/bugs/{bug_id}
  5. Get All Bugs:
    • GET /api/bugs
  6. Add Comment to Bug:
    • POST /api/bugs/{bug_id}/comments
  7. Get Bug Comments:
    • GET /api/bugs/{bug_id}/comments
  8. Add Attachment to Bug:
    • POST /api/bugs/{bug_id}/attachments
  9. Get Bug Attachments:
    • GET /api/bugs/{bug_id}/attachments
  10. Get Bug History:
    • GET /api/bugs/{bug_id}/history
  11. Track Time for Bug:
    • POST /api/bugs/{bug_id}/time-tracking
  12. Get Bug Time Tracking:
    • GET /api/bugs/{bug_id}/time-tracking
  13. Add Custom Field to Bug:
    • POST /api/bugs/{bug_id}/custom-fields
  14. Get Bug Custom Fields:
    • GET /api/bugs/{bug_id}/custom-fields

Notification Domain

Endpoints:

  1. Get User Notifications:
    • GET /api/users/{user_id}/notifications
  2. Mark Notification as Read:
    • PUT /api/notifications/{notification_id}/read
  3. Delete Notification:
    • DELETE /api/notifications/{notification_id}

Repository Management Domain

Endpoints:

  1. Create Repository:
    • POST /api/repositories
  2. Get Repository Details:
    • GET /api/repositories/{repo_id}
  3. Update Repository:
    • PUT /api/repositories/{repo_id}
  4. Delete Repository:
    • DELETE /api/repositories/{repo_id}
  5. Get All Repositories:
    • GET /api/repositories
  6. Link Bug to Repository:
    • POST /api/bugs/{bug_id}/repositories
  7. Get Repositories for Bug:
    • GET /api/bugs/{bug_id}/repositories

Summary of Endpoints:

User Management Domain

  • POST /api/users
  • GET /api/users/{user_id}
  • PUT /api/users/{user_id}
  • DELETE /api/users/{user_id}
  • POST /api/auth/login
  • POST /api/auth/logout
  • GET /api/users

Project Management Domain

  • POST /api/projects
  • GET /api/projects/{project_id}
  • PUT /api/projects/{project_id}
  • DELETE /api/projects/{project_id}
  • GET /api/projects

Bug Tracking Domain

  • POST /api/bugs
  • GET /api/bugs/{bug_id}
  • PUT /api/bugs/{bug_id}
  • DELETE /api/bugs/{bug_id}
  • GET /api/bugs
  • POST /api/bugs/{bug_id}/comments
  • GET /api/bugs/{bug_id}/comments
  • POST /api/bugs/{bug_id}/attachments
  • GET /api/bugs/{bug_id}/attachments
  • GET /api/bugs/{bug_id}/history
  • POST /api/bugs/{bug_id}/time-tracking
  • GET /api/bugs/{bug_id}/time-tracking
  • POST /api/bugs/{bug_id}/custom-fields
  • GET /api/bugs/{bug_id}/custom-fields

Notification Domain

  • GET /api/users/{user_id}/notifications
  • PUT /api/notifications/{notification_id}/read
  • DELETE /api/notifications/{notification_id}

Repository Management Domain

  • POST /api/repositories
  • GET /api/repositories/{repo_id}
  • PUT /api/repositories/{repo_id}
  • DELETE /api/repositories/{repo_id}
  • GET /api/repositories
  • POST /api/bugs/{bug_id}/repositories
  • GET /api/bugs/{bug_id}/repositories

These endpoints cover CRUD operations and specific actions required to manage users, projects, bugs, notifications, and repositories in the bug tracking system.