Skip to content

feat(instances): document calendar event linking - #597

Open
BASIC-BIT wants to merge 9 commits into
vrchatapi:mainfrom
BASIC-BIT:codex/document-update-instance
Open

feat(instances): document calendar event linking#597
BASIC-BIT wants to merge 9 commits into
vrchatapi:mainfrom
BASIC-BIT:codex/document-update-instance

Conversation

@BASIC-BIT

@BASIC-BIT BASIC-BIT commented Aug 31, 2026

Copy link
Copy Markdown

Summary

  • document PUT /instances/{worldId}:{instanceId} as updateInstance
  • add UpdateInstanceRequest with nullable calendarEntryId for linking and unlinking calendar events
  • extend the existing group-calendar lifecycle to create a members-only instance, verify linking and unlinking, close the instance, and retain the existing event/group cleanup

Closes #596.

@pkg-pr-new

pkg-pr-new Bot commented Sep 1, 2026

Copy link
Copy Markdown
pnpm add https://pkg.pr.new/vrchatapi/specification/vrchat@9565a5a

commit: 9565a5a

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 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 an UpdateInstanceRequest body supporting nullable calendarEntryId.
  • Introduced UpdateInstanceRequest request 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.

Comment thread openapi/components/paths/instances.yaml
Comment thread test/arazzo.yaml Outdated
Comment thread test/arazzo.yaml Outdated
Comment thread openapi/components/paths/instances.yaml Outdated
@BASIC-BIT
BASIC-BIT force-pushed the codex/document-update-instance branch from accb0a4 to b883025 Compare September 3, 2026 07:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

Document PUT /instances/{worldId}:{instanceId} for updating an instance calendar link

2 participants