Document out of office API endpoints#387
Open
robzolkos wants to merge 2 commits intobasecamp:masterfrom
Open
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.
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.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.