Document out of office API endpoints#387
Conversation
There was a problem hiding this comment.
Pull request overview
Adds documentation for the “out of office” API within the People section, describing how clients can read and update a user’s out-of-office status.
Changes:
- Add “Get out of office” endpoint docs (
GET /out_of_office.json) with example response. - Add “Update out of office” endpoint docs (
PUT /out_of_office.json) with parameters and example request/cURL.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
robzolkos
force-pushed
the
api-out-of-office
branch
from
fb024ae to
00ed665
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
Comments suppressed due to low confidence (1)
sections/out_of_office.md:106
- The file defines a
[1]footnote reference at the bottom, but[1]is never referenced in the document. Please remove the unused footnote or add a corresponding in-text reference so the link isn’t dead weight.
[1]: https://github.com/basecamp/bc3-api/blob/master/sections/people.md#get-person
💡 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.
Add new out_of_office.md section with GET, PUT, DELETE endpoints nested under people. Note ISO 8601 date format in person JSON response. Update README endpoint index.
jeremy
force-pushed
the
api-out-of-office
branch
from
96ec331 to
bc30b33
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| * `POST /people/2/out_of_office.json` will enable or replace out of office for the person with the given ID. | ||
|
|
||
| Admins on accounts with a Pro Pack can enable out of office on behalf of other people. Otherwise, you can only manage your own out of office. | ||
|
|
||
| This endpoint will return `200 OK` with the current JSON representation of the out of office if the creation was a success. If the person already has an out of office set, it will be replaced. |
There was a problem hiding this comment.
The PR description (and prior thread resolution) indicates this endpoint should be PUT, but this doc currently describes it as POST. Please align the HTTP verb here (and in the corresponding example markers/cURL) so the published contract is consistent.
Summary
sections/out_of_office.mdwith GET, PUT, DELETE endpoints nested under/people/:person_id/out_of_officeout_of_officein person JSON response (people.md)Companion to basecamp/bc3#9925.