{ "openapi": "3.0.0", "paths": { "/v1/health": { "get": { "operationId": "HealthController_check", "parameters": [], "responses": { "200": { "description": "The Health Check is successful", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "ok" }, "info": { "type": "object", "example": { "database": { "status": "up" } }, "additionalProperties": { "type": "object", "properties": { "status": { "type": "string" } }, "additionalProperties": { "type": "string" } }, "nullable": true }, "error": { "type": "object", "example": {}, "additionalProperties": { "type": "object", "properties": { "status": { "type": "string" } }, "additionalProperties": { "type": "string" } }, "nullable": true }, "details": { "type": "object", "example": { "database": { "status": "up" } }, "additionalProperties": { "type": "object", "properties": { "status": { "type": "string" } }, "additionalProperties": { "type": "string" } } } } } } } }, "503": { "description": "The Health Check is not successful", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "error" }, "info": { "type": "object", "example": { "database": { "status": "up" } }, "additionalProperties": { "type": "object", "properties": { "status": { "type": "string" } }, "additionalProperties": { "type": "string" } }, "nullable": true }, "error": { "type": "object", "example": { "redis": { "status": "down", "message": "Could not connect" } }, "additionalProperties": { "type": "object", "properties": { "status": { "type": "string" } }, "additionalProperties": { "type": "string" } }, "nullable": true }, "details": { "type": "object", "example": { "database": { "status": "up" }, "redis": { "status": "down", "message": "Could not connect" } }, "additionalProperties": { "type": "object", "properties": { "status": { "type": "string" } }, "additionalProperties": { "type": "string" } } } } } } } } } } }, "/v1/instances": { "get": { "operationId": "InstanceController_findAll", "parameters": [], "responses": { "200": { "description": "" } } }, "post": { "operationId": "InstanceController_create", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDto" } } } }, "responses": { "201": { "description": "" } } }, "delete": { "operationId": "InstanceController_delete", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDto" } } } }, "responses": { "200": { "description": "" } } } }, "/instances": { "get": { "operationId": "InstanceController_findAll", "parameters": [], "responses": { "200": { "description": "" } } }, "post": { "operationId": "InstanceController_create", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDto" } } } }, "responses": { "201": { "description": "" } } }, "delete": { "operationId": "InstanceController_delete", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDto" } } } }, "responses": { "200": { "description": "" } } } } }, "info": { "title": "@galaxyops/instances", "description": "An API for maintaining game instances", "version": "0.0.1", "contact": {} }, "tags": [], "servers": [], "components": { "schemas": { "CreateDto": { "type": "object", "properties": { "playerId": { "type": "string", "description": "The instance id", "default": "849b2e22-a525-4924-9d61-7e880a82575f" } }, "required": ["playerId"] }, "DeleteDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The instance id", "default": "6dc929d8-7ab5-489d-ab68-70d241a02fcd" } }, "required": ["id"] } } } }