api+openapi: GET /api/tech + POST /api/research with 400/404/409/422 mapping

This commit is contained in:
2026-09-29 00:30:10 +00:00
parent 8818f0928d
commit 7b0227cde9
4 changed files with 160 additions and 0 deletions
+106
View File
@@ -378,6 +378,82 @@ export const openApiSpec = {
},
},
},
'/api/tech': {
get: {
summary: 'Tech tree state',
description:
"The full technology tree with per-save state — RESEARCHED if done, AVAILABLE if all prerequisites are researched, LOCKED otherwise (with the missing prerequisite names). Researching a tech gates or raises ship actions (e.g. building WEAPONS requires the WEAPONS SYSTEMS tech). Auto-initializes a new game when no save exists yet.",
operationId: 'getTech',
responses: {
200: {
description: 'The tech tree with per-save state',
content: {
'application/json': {
schema: { type: 'array', items: { $ref: '#/components/schemas/Tech' } },
},
},
},
},
},
},
'/api/research': {
post: {
summary: 'Research a tech',
description:
"Validates the prerequisites (409, naming what is missing) and the cost against the cargo hold (422), spends the cost from the oldest row first, marks the tech researched, increments the turn counter and writes a research event. Returns the fresh tech tree state.",
operationId: 'researchTech',
requestBody: {
required: true,
content: {
'application/json': {
schema: { $ref: '#/components/schemas/ResearchRequest' },
},
},
},
responses: {
200: {
description: 'Fresh tech tree state after the research',
content: {
'application/json': {
schema: { type: 'array', items: { $ref: '#/components/schemas/Tech' } },
},
},
},
400: {
description: 'Malformed body or non-integer techId',
content: {
'application/json': {
schema: { $ref: '#/components/schemas/Error' },
},
},
},
404: {
description: 'Unknown tech id',
content: {
'application/json': {
schema: { $ref: '#/components/schemas/Error' },
},
},
},
409: {
description: 'Tech is already researched or a prerequisite is not researched yet (message names the missing prereq)',
content: {
'application/json': {
schema: { $ref: '#/components/schemas/Error' },
},
},
},
422: {
description: 'Not enough of the required kind in the cargo hold for the cost',
content: {
'application/json': {
schema: { $ref: '#/components/schemas/Error' },
},
},
},
},
},
},
},
components: {
schemas: {
@@ -491,6 +567,36 @@ export const openApiSpec = {
},
required: ['systems', 'inventory', 'turn'],
},
Tech: {
type: 'object',
properties: {
id: { type: 'integer' },
slug: { type: 'string', description: "Stable key, e.g. WEAPONS_SYSTEMS" },
name: { type: 'string', description: "Display name, e.g. 'WEAPONS SYSTEMS'" },
costKind: { type: 'string', enum: ['resource', 'part'] },
costQty: { type: 'integer' },
prereqs: {
type: 'array',
description: 'Prerequisite tech names (empty for roots)',
items: { type: 'string' },
},
effect: { type: 'string', description: "Human-readable unlock, e.g. 'Unlocks building the WEAPONS system'" },
state: { type: 'string', enum: ['RESEARCHED', 'AVAILABLE', 'LOCKED'] },
missingPrereqs: {
type: 'array',
description: 'Unmet prerequisite names — non-empty only when LOCKED',
items: { type: 'string' },
},
},
required: ['id', 'slug', 'name', 'costKind', 'costQty', 'prereqs', 'effect', 'state', 'missingPrereqs'],
},
ResearchRequest: {
type: 'object',
properties: {
techId: { type: 'integer', description: 'tech.id of the tech to research' },
},
required: ['techId'],
},
UpgradeRequest: {
type: 'object',
properties: {