Skip to content

Document the default full Steam batch lookup response example #457

Description

@coderabbitai

Summary

The generated OpenAPI success example for games.batchBySteamAppIds currently shows the minimal result variant, while BatchBySteamAppIdsSchema.minimal defaults to false and the default response is the full result shape.

Required changes

  • Update getResponseExampleOverride in src/scripts/api/generate-api-docs.ts so the BatchBySteamAppIdsResponseSchema example represents the default full response shape.
  • Include the full-result fields such as steamAppId, game, matchStrategy, and the nested system and listings data.
  • Alternatively, explicitly label the current example as applying to minimal: true.
  • Regenerate public/api-docs/mobile-openapi.json so the documented endpoint success example matches the selected behavior.

Rationale

API consumers should be able to rely on the default request/response examples. Documenting the minimal response as the default can lead clients to model the wrong contract.

Affected areas

  • src/scripts/api/generate-api-docs.ts
  • public/api-docs/mobile-openapi.json

Acceptance criteria

  • The generated example accurately reflects minimal: false, or is unambiguously documented as a minimal: true example.
  • The OpenAPI JSON is regenerated from the updated generator.
  • The endpoint documentation and response schema/example are consistent.

Backlinks

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions