Skip to content

fix(openapi): document Staff API wire responses - #398

Merged
stakach merged 3 commits into
masterfrom
fix/staff-openapi-document-397
Nov 19, 2026
Merged

stakach merged 3 commits into
masterfrom
fix/staff-openapi-document-397

Conversation

@stakach

@stakach stakach commented Nov 19, 2026

Copy link
Copy Markdown
Member

Closes #397.

Regenerate the OpenAPI document with the updated JSON Schema and PlaceOS models. The generated output documents all 33 reported Unix-second timestamp fields as integer/Int64 and includes the read-only fields that Booking and Guest serialize.

Declare the calendars availability endpoint’s bodyless 204 for the empty-calendar case alongside the JSON array 200. The controller spec covers the HTTP response and the generated response declarations.

@github-actions github-actions Bot added the type: bug something isn't working label Nov 19, 2026
@github-actions github-actions Bot added type: bug something isn't working and removed type: bug something isn't working labels Nov 19, 2026
@stakach
stakach merged commit 4c7ed24 into master Nov 19, 2026
12 checks passed
@stakach
stakach deleted the fix/staff-openapi-document-397 branch November 19, 2026 02:53
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: regenerate with the json-schema fix for Unix-second timestamps

1 participant