specification icon indicating copy to clipboard operation
specification copied to clipboard

The type of 'instancePersistenceEnabled' in the instance schema may be incorrect

Open tksimeji opened this issue 3 months ago • 0 comments

Thank you for the fantastic API!!

I found a possible discrepancy between the OpenAPI schema and the actual API response:

In the OpenAPI schema for Instance, the field instancePersistenceEnabled is defined as a string.

https://github.com/vrchatapi/specification/blob/5708eeecae7d280b64aaf84896f1b1ed01228d63/openapi/components/schemas/Instance.yaml#L44-L46

However, in actual responses (e.g. from POST https://api.vrchat.cloud/api/1/instances), instancePersistenceEnabled comes back as a boolean, for example:

{
  "...",
  "instancePersistenceEnabled": true,
  "..."
}

If the schema were followed strictly, one would expect:

{
  "...",
  "instancePersistenceEnabled": "true",
  "..."
}

Would it be possible to update the schema to match the actual API behavior,

Thank you! (Sorry if this is the wrong place to report this.)

tksimeji avatar Sep 18 '25 02:09 tksimeji