api: GET /api/crew roster endpoint, OpenAPI spec updated in code

2026-09-28 22:47:18 +00:00
parent 7a9ff110f3
commit a2c8586618
3 changed files with 57 additions and 1 deletions
@@ -5,6 +5,7 @@ import { openApiSpec } from './openapi';
 describe('OpenAPI spec', () => {
  it('documents every public endpoint', () => {
    expect(Object.keys(openApiSpec.paths).sort()).toEqual([
+      '/api/crew',
      '/api/explore',
      '/api/jump',
      '/api/system',
@@ -13,6 +14,19 @@ describe('OpenAPI spec', () => {
    ]);
  });

+  it('describes /api/crew as an array of CrewMember and crewFound on ExploreResult', () => {
+    const crew = openApiSpec.paths['/api/crew'].get.responses[200].content['application/json'].schema;
+    expect(crew.type).toBe('array');
+    expect((crew.items as { $ref: string }).$ref).toBe('#/components/schemas/CrewMember');
+
+    const member = openApiSpec.components.schemas.CrewMember.properties;
+    expect(Object.keys(member)).toEqual(['id', 'name', 'role', 'trait_good', 'trait_bad', 'origin']);
+
+    const exploreResult = openApiSpec.components.schemas.ExploreResult as { allOf: unknown[] };
+    const extra = (exploreResult.allOf[1] as { properties: Record<string, unknown> }).properties;
+    expect(Object.keys(extra)).toEqual(['outcome', 'crewFound']);
+  });
+
  it('describes the system endpoints as SystemState in and out', () => {
    const system = openApiSpec.paths['/api/system'].get.responses[200].content['application/json'].schema;
    expect(system.$ref).toBe('#/components/schemas/SystemState');