Skip to content

Document my assignments API endpoints#393

Open
robzolkos wants to merge 3 commits intobasecamp:masterfrom
robzolkos:rzolkos/assignments-docs
Open

Document my assignments API endpoints#393
robzolkos wants to merge 3 commits intobasecamp:masterfrom
robzolkos:rzolkos/assignments-docs

Conversation

@robzolkos
Copy link
Contributor

Summary

  • Add sections/my_assignments.md documenting three new API endpoints from basecamp/bc3#9932:
    • GET /my/assignments.json — active assignments split into priorities and non-priorities, with card/step normalization
    • GET /my/assignments/completed.json — completed assignments (excludes archived/trashed)
    • GET /my/assignments/due.json — due assignments filtered by scope (overdue, due_today, due_tomorrow, due_later_this_week, due_next_week, due_later)
  • Add "My assignments" to the README endpoint index

Copilot AI review requested due to automatic review settings March 12, 2026 20:04
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds public documentation for the new “My assignments” API endpoints so integrators can retrieve the current user’s active, completed, and due assignments, and surfaces the new section in the main endpoint index.

Changes:

  • Add a new sections/my_assignments.md doc covering GET /my/assignments.json, /completed.json, and /due.json (including examples and cURL snippets).
  • Add “My assignments” to the README’s API endpoint index.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
sections/my_assignments.md New documentation section for the three “my assignments” endpoints, including response examples and parameter notes.
README.md Adds the “My assignments” section link to the API endpoints index.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Copilot AI review requested due to automatic review settings March 12, 2026 20:13
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

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.

2 participants