feat(instances): document calendar event linking - #597
Open
BASIC-BIT wants to merge 9 commits into
Open
Conversation
commit: |
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The new updateInstance operation is missing key spec elements for an authenticated endpoint (notably requestBody.required: true and a documented 401 response), and the added workflow would benefit from additional negative-path coverage.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Adds documented support and test coverage for linking/unlinking a calendar event to an instance via PUT /instances/{worldId}:{instanceId}, and extends the conformance workflow to exercise this behavior end-to-end.
Changes:
- Added
updateInstance(PUT /instances/{worldId}:{instanceId}) with anUpdateInstanceRequestbody supporting nullablecalendarEntryId. - Introduced
UpdateInstanceRequestrequest schema to link (string) or unlink (null) an instance’s calendar event. - Extended the existing group-calendar lifecycle workflow to create a members-only group instance, link/unlink it to a calendar event, and close the instance.
File summaries
| File | Description |
|---|---|
test/arazzo.yaml |
Extends the group-calendar lifecycle workflow to create an instance and validate calendar link/unlink behavior, then closes the instance. |
openapi/components/requests/UpdateInstanceRequest.yaml |
Adds request schema allowing calendarEntryId to be set or cleared (null). |
openapi/components/paths/instances.yaml |
Documents PUT /instances/{worldId}:{instanceId} as updateInstance with the new request body. |
Review details
- Files reviewed: 3/3 changed files
- Comments generated: 4
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
BASIC-BIT
force-pushed
the
codex/document-update-instance
branch
from
September 3, 2026 07:25
accb0a4 to
b883025
Compare
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
PUT /instances/{worldId}:{instanceId}asupdateInstanceUpdateInstanceRequestwith nullablecalendarEntryIdfor linking and unlinking calendar eventsCloses #596.