Skip to content

fix(openapi): align schemas with serialized fields - #471

Merged
stakach merged 1 commit into
masterfrom
fix/openapi-wire-schemas-470
Nov 19, 2026
Merged

stakach merged 1 commit into
masterfrom
fix/openapi-wire-schemas-470

Conversation

@stakach

@stakach stakach commented Nov 19, 2026

Copy link
Copy Markdown
Member

Closes #470.

Regenerate the OpenAPI document with JSON Schema 2.1.3 and the updated PlaceOS models. The document includes response-only fields, typed user metadata, string representations for timezones, URIs and JWT scopes, numeric values for converter-backed enums, and free-form JSON where the wire format allows it.

Parse OAuth application path IDs as Int64 to match the database primary key. The route regression uses an ID above Int32::MAX.

Build and schema audit verified the reported examples, the previous Unix timestamp corrections, and all internal component references.

@github-actions github-actions Bot added the type: bug something isn't working label Nov 19, 2026
@stakach
stakach merged commit bbd7e95 into master Nov 19, 2026
11 checks passed
@stakach
stakach deleted the fix/openapi-wire-schemas-470 branch November 19, 2026 02:51
MrYuion added a commit to PlaceOS/ts-client that referenced this pull request Nov 19, 2026
PlaceOS/rest-api#471 and PlaceOS/staff-api#398 regenerated the API
documents, so the patches for string fields, missing read-only fields,
number enums and the staff-api time fields are gone.

- The time fields and the number enums keep their notes: the unit and
  the name of each number.
- The generator accepts `readOnly`, and a 204 next to the success
  response. The client gives `null` for a 204, so
  staff.calendars.availability has nullable data.
- The fields that refer back to Booking are `json()`, because the
  schemas cannot have a cycle.
- oauth_applications path IDs are integers. The inline enums of the
  documents are no longer named exports.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: bug something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

OpenAPI doc leaves out read-only fields and types some strings as object

1 participant