Skip to content

docs(openapi): declare GET/PATCH/DELETE /v1/timeentry/{id} envelopes (#358)#359

Merged
CryptoJones merged 1 commit into
masterfrom
docs/openapi-timeentry-byid-response-shapes
May 19, 2026
Merged

docs(openapi): declare GET/PATCH/DELETE /v1/timeentry/{id} envelopes (#358)#359
CryptoJones merged 1 commit into
masterfrom
docs/openapi-timeentry-byid-response-shapes

Conversation

@CryptoJones
Copy link
Copy Markdown
Owner

Closes #358.

Summary

Declares the three operation 200 envelopes: GET/PATCH emit {message, timeEntry}; DELETE emits {message, id}. Sweep test pins each.

Test plan

  • npm run lint && npm test — 795 passing (was 794).

Proudly Made in Nebraska. Go Big Red! 🌽 https://xkcd.com/2347/

…nvelopes

The single-row time-entry endpoints had only `description: ...` on
their 200 responses — same missing-content-schema pattern fixed for
the customer single GET (#312), POST (#316), bulk (#332), bycompany
list (#340), and timeentry POST (#326) + bycompany list (#348).
Without the declaration, SDK code-gen treated the response body
as untyped.

Pin all three operations on this path:
  - GET   → {message, timeEntry}
  - PATCH → {message, timeEntry}
  - DELETE → {message, id}  (no entity body; the row was archived,
                              the controller echoes the int teId
                              so the client can confirm what got
                              soft-deleted)

Add a sweep test in tests/api/openapi.test.js covering all three.
The DELETE assertion also pins the absence of a `timeEntry` field
so a future "echo the row back on delete" refactor would surface
as a test failure.

Test count: 794 → 795.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@CryptoJones CryptoJones merged commit 0453076 into master May 19, 2026
3 checks passed
@CryptoJones CryptoJones deleted the docs/openapi-timeentry-byid-response-shapes branch May 19, 2026 19:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

OpenAPI: /v1/timeentry/{id} GET/PATCH/DELETE 200 have no content schema

1 participant