https://docs.microservice-dungeon.de/docs/reference/map-service/ Recent content in Map Service on Microservice Dungeon Hugo en https://docs.microservice-dungeon.de/docs/reference/map-service/openapi/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.microservice-dungeon.de/docs/reference/map-service/openapi/ <div id="docsy_swagger_ui"></div> <script> window.onload = function () { const ui = SwaggerUIBundle({ spec: JSON.parse("{\"components\":{\"schemas\":{\"ErrorResponse\":{\"properties\":{\"message\":{\"example\":\"Template is built-in and cannot be modified\",\"type\":\"string\"}},\"type\":\"object\"},\"GravityZone\":{\"properties\":{\"coordinate\":{\"description\":\"Required for type \\\"tile\\\"\",\"pattern\":\"^\\\\(\\\\d+,\\\\d+\\\\)$\",\"type\":\"string\"},\"fromRingIndex\":{\"description\":\"Required for type \\\"ring\\\"\",\"minimum\":0,\"type\":\"integer\"},\"gravityLevel\":{\"enum\":[\"light\",\"medium\",\"intense\"],\"type\":\"string\"},\"lowerLeft\":{\"description\":\"Required for type \\\"rectangle\\\"\",\"pattern\":\"^\\\\(\\\\d+,\\\\d+\\\\)$\",\"type\":\"string\"},\"toRingIndex\":{\"description\":\"Required for type \\\"ring\\\"\",\"minimum\":0,\"type\":\"integer\"},\"type\":{\"$ref\":\"#/components/schemas/ZoneGeometryType\"},\"upperRight\":{\"description\":\"Required for type \\\"rectangle\\\"\",\"pattern\":\"^\\\\(\\\\d+,\\\\d+\\\\)$\",\"type\":\"string\"}},\"required\":[\"type\",\"gravityLevel\"],\"type\":\"object\"},\"MapStructureZone\":{\"properties\":{\"coordinate\":{\"pattern\":\"^\\\\(\\\\d+,\\\\d+\\\\)$\",\"type\":\"string\"},\"fromRingIndex\":{\"minimum\":0,\"type\":\"integer\"},\"lowerLeft\":{\"pattern\":\"^\\\\(\\\\d+,\\\\d+\\\\)$\",\"type\":\"string\"},\"spaceType\":{\"enum\":[\"planet\",\"void\"],\"type\":\"string\"},\"toRingIndex\":{\"minimum\":0,\"type\":\"integer\"},\"type\":{\"$ref\":\"#/components/schemas/ZoneGeometryType\"},\"upperRight\":{\"pattern\":\"^\\\\(\\\\d+,\\\\d+\\\\)$\",\"type\":\"string\"}},\"required\":[\"type\",\"spaceType\"],\"type\":\"object\"},\"MapTemplateDetail\":{\"properties\":{\"builtIn\":{\"description\":\"Built-in templates are loaded on startup from the system's seed data. They cannot be modified or deleted via the API.\\n\",\"type\":\"boolean\"},\"description\":{\"nullable\":true,\"type\":\"string\"},\"gravityZones\":{\"items\":{\"$ref\":\"#/components/schemas/GravityZone\"},\"type\":\"array\"},\"id\":{\"format\":\"uuid\",\"type\":\"string\"},\"mapStructureZones\":{\"items\":{\"$ref\":\"#/components/schemas/MapStructureZone\"},\"type\":\"array\"},\"name\":{\"type\":\"string\"},\"planetTypeDistributionZones\":{\"items\":{\"$ref\":\"#/components/schemas/PlanetTypeDistributionZone\"},\"type\":\"array\"},\"replenishmentZones\":{\"items\":{\"$ref\":\"#/components/schemas/ReplenishmentZone\"},\"type\":\"array\"},\"topRightCorner\":{\"pattern\":\"^\\\\(\\\\d+,\\\\d+\\\\)$\",\"type\":\"string\"}},\"type\":\"object\"},\"MapTemplatePatchRequest\":{\"description\":\"All fields are optional. Only provided fields are updated. When a zone array is provided, it replaces the entire list.\\n\",\"properties\":{\"description\":{\"nullable\":true,\"type\":\"string\"},\"gravityZones\":{\"items\":{\"$ref\":\"#/components/schemas/GravityZone\"},\"type\":\"array\"},\"mapStructureZones\":{\"items\":{\"$ref\":\"#/components/schemas/MapStructureZone\"},\"type\":\"array\"},\"name\":{\"type\":\"string\"},\"planetTypeDistributionZones\":{\"items\":{\"$ref\":\"#/components/schemas/PlanetTypeDistributionZone\"},\"type\":\"array\"},\"replenishmentZones\":{\"items\":{\"$ref\":\"#/components/schemas/ReplenishmentZone\"},\"type\":\"array\"},\"topRightCorner\":{\"pattern\":\"^\\\\(\\\\d+,\\\\d+\\\\)$\",\"type\":\"string\"}},\"type\":\"object\"},\"MapTemplateRequest\":{\"properties\":{\"description\":{\"nullable\":true,\"type\":\"string\"},\"gravityZones\":{\"items\":{\"$ref\":\"#/components/schemas/GravityZone\"},\"type\":\"array\"},\"mapStructureZones\":{\"items\":{\"$ref\":\"#/components/schemas/MapStructureZone\"},\"type\":\"array\"},\"name\":{\"type\":\"string\"},\"planetTypeDistributionZones\":{\"items\":{\"$ref\":\"#/components/schemas/PlanetTypeDistributionZone\"},\"type\":\"array\"},\"replenishmentZones\":{\"items\":{\"$ref\":\"#/components/schemas/ReplenishmentZone\"},\"type\":\"array\"},\"topRightCorner\":{\"pattern\":\"^\\\\(\\\\d+,\\\\d+\\\\)$\",\"type\":\"string\"}},\"required\":[\"name\",\"topRightCorner\"],\"type\":\"object\"},\"MapTemplateSummary\":{\"properties\":{\"description\":{\"nullable\":true,\"type\":\"string\"},\"id\":{\"format\":\"uuid\",\"type\":\"string\"},\"name\":{\"type\":\"string\"}},\"type\":\"object\"},\"PlanetTypeDistributionZone\":{\"properties\":{\"coordinate\":{\"pattern\":\"^\\\\(\\\\d+,\\\\d+\\\\)$\",\"type\":\"string\"},\"count\":{\"description\":\"How many planets of this type to place. Defaults to \\\"1\\\" for tile geometry. Supports fixed numbers (\\\"5\\\") or expressions (\\\"empty_planets * 0.25\\\").\\n\",\"type\":\"string\"},\"fromRingIndex\":{\"minimum\":0,\"type\":\"integer\"},\"lowerLeft\":{\"pattern\":\"^\\\\(\\\\d+,\\\\d+\\\\)$\",\"type\":\"string\"},\"planetUsageType\":{\"enum\":[\"space_station\",\"space_station_no_spawning\",\"resource_mine\",\"black_hole\"],\"type\":\"string\"},\"resource\":{\"description\":\"Required for planetUsageType \\\"resource_mine\\\". Format: \\\"\\u003camount\\u003e \\u003ctype_key\\u003e\\\" (e.g. \\\"2000 id\\\").\\n\",\"type\":\"string\"},\"toRingIndex\":{\"minimum\":0,\"type\":\"integer\"},\"type\":{\"$ref\":\"#/components/schemas/ZoneGeometryType\"},\"upperRight\":{\"pattern\":\"^\\\\(\\\\d+,\\\\d+\\\\)$\",\"type\":\"string\"}},\"required\":[\"type\",\"planetUsageType\"],\"type\":\"object\"},\"ReplenishmentZone\":{\"properties\":{\"coordinate\":{\"pattern\":\"^\\\\(\\\\d+,\\\\d+\\\\)$\",\"type\":\"string\"},\"fromRingIndex\":{\"minimum\":0,\"type\":\"integer\"},\"location\":{\"description\":\"Whether to replenish at existing or new locations\",\"enum\":[\"EXISTING\",\"NEW\"],\"type\":\"string\"},\"lowerLeft\":{\"pattern\":\"^\\\\(\\\\d+,\\\\d+\\\\)$\",\"type\":\"string\"},\"onlyForResource\":{\"description\":\"Restrict replenishment to a specific resource type\",\"enum\":[\"BIO_MATTER\",\"CRYO_GAS\",\"DARK_MATTER\",\"ION_DUST\",\"PLASMA_CORES\"],\"nullable\":true,\"type\":\"string\"},\"replenishBy\":{\"description\":\"Amount of resources to add during replenishment\",\"minimum\":1,\"type\":\"integer\"},\"threshold\":{\"description\":\"Resource amount below which replenishment is triggered\",\"minimum\":0,\"type\":\"integer\"},\"toRingIndex\":{\"minimum\":0,\"type\":\"integer\"},\"type\":{\"$ref\":\"#/components/schemas/ZoneGeometryType\"},\"upperRight\":{\"pattern\":\"^\\\\(\\\\d+,\\\\d+\\\\)$\",\"type\":\"string\"}},\"required\":[\"type\",\"threshold\",\"replenishBy\"],\"type\":\"object\"},\"ZoneGeometryType\":{\"enum\":[\"tile\",\"rectangle\",\"ring\"],\"type\":\"string\"}}},\"info\":{\"description\":\"Admin API for managing map templates and the default template selection.\",\"title\":\"Map-Service REST API\",\"version\":\"1.0.0\"},\"openapi\":\"3.0.3\",\"paths\":{\"/map-templates\":{\"get\":{\"description\":\"Returns a summary list of all map templates. Use GET /map-templates/{templateId} to retrieve the full template with all zone definitions.\\n\",\"operationId\":\"getAllMapTemplates\",\"responses\":{\"200\":{\"content\":{\"application/json\":{\"example\":[{\"description\":\"Template for a tiny map (3x3, from (0,0) to (2,2), very close to the minimal size)\",\"id\":\"a1b2c3d4-0001-4000-8000-000000000001\",\"name\":\"Tiny Map\"},{\"description\":\"Template for a small map (10x8, from (0,0) to (9,7), suitable for up to 5 players)\",\"id\":\"a1b2c3d4-0002-4000-8000-000000000002\",\"name\":\"Small Map\"},{\"description\":\"Template for an arena map (21x11, from (0,0) to (20,10), two bases with a central arena)\",\"id\":\"a1b2c3d4-0003-4000-8000-000000000003\",\"name\":\"Arena\"},{\"description\":\"Template for a maze map (18x18, from (0,0) to (17,17), suitable for larger groups)\",\"id\":\"a1b2c3d4-0004-4000-8000-000000000004\",\"name\":\"Maze\"},{\"description\":\"A small custom 5x5 map for quick testing\",\"id\":\"f5e6d7c8-9999-4000-8000-aaaaaaaaaaaa\",\"name\":\"My Custom Map\"}],\"schema\":{\"items\":{\"$ref\":\"#/components/schemas/MapTemplateSummary\"},\"type\":\"array\"}}},\"description\":\"All map templates\"}},\"summary\":\"List all map templates\"},\"post\":{\"operationId\":\"createMapTemplate\",\"requestBody\":{\"content\":{\"application/json\":{\"example\":{\"description\":\"A small custom 5x5 map for quick testing\",\"gravityZones\":[{\"fromRingIndex\":0,\"gravityLevel\":\"light\",\"toRingIndex\":1,\"type\":\"ring\"},{\"fromRingIndex\":2,\"gravityLevel\":\"medium\",\"toRingIndex\":2,\"type\":\"ring\"}],\"mapStructureZones\":[{\"coordinate\":\"(1,1)\",\"spaceType\":\"void\",\"type\":\"tile\"}],\"name\":\"My Custom Map\",\"planetTypeDistributionZones\":[{\"coordinate\":\"(0,0)\",\"planetUsageType\":\"space_station\",\"type\":\"tile\"},{\"count\":\"2\",\"fromRingIndex\":2,\"planetUsageType\":\"resource_mine\",\"resource\":\"2000 id\",\"toRingIndex\":2,\"type\":\"ring\"}],\"replenishmentZones\":[],\"topRightCorner\":\"(4,4)\"},\"schema\":{\"$ref\":\"#/components/schemas/MapTemplateRequest\"}}},\"required\":true},\"responses\":{\"201\":{\"content\":{\"application/json\":{\"example\":{\"description\":\"A small custom 5x5 map for quick testing\",\"id\":\"f5e6d7c8-9999-4000-8000-aaaaaaaaaaaa\",\"name\":\"My Custom Map\"},\"schema\":{\"$ref\":\"#/components/schemas/MapTemplateSummary\"}}},\"description\":\"Template created\"},\"400\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}},\"description\":\"Invalid template data or duplicate name\"}},\"summary\":\"Create a new map template\"}},\"/map-templates/default\":{\"get\":{\"description\":\"Returns a summary of the template that will be instantiated when a new game is created.\\n\",\"operationId\":\"getDefaultMapTemplate\",\"responses\":{\"200\":{\"content\":{\"application/json\":{\"example\":{\"description\":\"Template for a small map (10x8, from (0,0) to (9,7), suitable for up to 5 players)\",\"id\":\"a1b2c3d4-0002-4000-8000-000000000002\",\"name\":\"Small Map\"},\"schema\":{\"$ref\":\"#/components/schemas/MapTemplateSummary\"}}},\"description\":\"The current default template\"}},\"summary\":\"Get the current default map template\"}},\"/map-templates/default/{templateId}\":{\"parameters\":[{\"in\":\"path\",\"name\":\"templateId\",\"required\":true,\"schema\":{\"format\":\"uuid\",\"type\":\"string\"}}],\"put\":{\"description\":\"Sets which template will be instantiated when a new game is created.\\n\",\"operationId\":\"setDefaultMapTemplate\",\"responses\":{\"200\":{\"content\":{\"application/json\":{\"example\":{\"description\":\"A small custom 5x5 map for quick testing\",\"id\":\"f5e6d7c8-9999-4000-8000-aaaaaaaaaaaa\",\"name\":\"My Custom Map\"},\"schema\":{\"$ref\":\"#/components/schemas/MapTemplateSummary\"}}},\"description\":\"Default template updated\"},\"404\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}},\"description\":\"Template not found\"}},\"summary\":\"Change the default map template\"}},\"/map-templates/{templateId}\":{\"delete\":{\"description\":\"Deletes the template. Built-in templates cannot be deleted. The current default template cannot be deleted.\\n\",\"operationId\":\"deleteMapTemplate\",\"responses\":{\"204\":{\"description\":\"Template deleted\"},\"404\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}},\"description\":\"Template not found\"},\"409\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}},\"description\":\"Template is built-in or is the current default\"}},\"summary\":\"Delete a map template\"},\"get\":{\"description\":\"Returns the full template including all zone definitions and the builtIn flag.\\n\",\"operationId\":\"getMapTemplate\",\"responses\":{\"200\":{\"content\":{\"application/json\":{\"example\":{\"builtIn\":false,\"description\":\"A small custom 5x5 map for quick testing\",\"gravityZones\":[{\"fromRingIndex\":0,\"gravityLevel\":\"light\",\"toRingIndex\":1,\"type\":\"ring\"},{\"fromRingIndex\":2,\"gravityLevel\":\"medium\",\"toRingIndex\":2,\"type\":\"ring\"}],\"id\":\"f5e6d7c8-9999-4000-8000-aaaaaaaaaaaa\",\"mapStructureZones\":[{\"coordinate\":\"(1,1)\",\"spaceType\":\"void\",\"type\":\"tile\"}],\"name\":\"My Custom Map\",\"planetTypeDistributionZones\":[{\"coordinate\":\"(0,0)\",\"planetUsageType\":\"space_station\",\"type\":\"tile\"},{\"count\":\"2\",\"fromRingIndex\":2,\"planetUsageType\":\"resource_mine\",\"resource\":\"2000 id\",\"toRingIndex\":2,\"type\":\"ring\"}],\"replenishmentZones\":[],\"topRightCorner\":\"(4,4)\"},\"schema\":{\"$ref\":\"#/components/schemas/MapTemplateDetail\"}}},\"description\":\"The requested template\"},\"404\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}},\"description\":\"Template not found\"}},\"summary\":\"Get a map template by ID\"},\"parameters\":[{\"in\":\"path\",\"name\":\"templateId\",\"required\":true,\"schema\":{\"format\":\"uuid\",\"type\":\"string\"}}],\"patch\":{\"description\":\"Updates only the provided fields of the template. Omitted fields remain unchanged. Built-in templates cannot be modified.\\n\",\"operationId\":\"patchMapTemplate\",\"requestBody\":{\"content\":{\"application/json\":{\"example\":{\"description\":\"Updated description for my custom map\"},\"schema\":{\"$ref\":\"#/components/schemas/MapTemplatePatchRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"content\":{\"application/json\":{\"example\":{\"description\":\"Updated description for my custom map\",\"id\":\"f5e6d7c8-9999-4000-8000-aaaaaaaaaaaa\",\"name\":\"My Custom Map\"},\"schema\":{\"$ref\":\"#/components/schemas/MapTemplateSummary\"}}},\"description\":\"Template updated\"},\"400\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}},\"description\":\"Invalid template data\"},\"404\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}},\"description\":\"Template not found\"},\"409\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}},\"description\":\"Template is built-in and cannot be modified\"}},\"summary\":\"Partially update a map template\"},\"put\":{\"description\":\"Replaces the template with the given data. Built-in templates cannot be modified.\\n\",\"operationId\":\"updateMapTemplate\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/MapTemplateRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/MapTemplateSummary\"}}},\"description\":\"Template updated\"},\"400\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}},\"description\":\"Invalid template data\"},\"404\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}},\"description\":\"Template not found\"},\"409\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorResponse\"}}},\"description\":\"Template is built-in and cannot be modified\"}},\"summary\":\"Replace a map template\"}}}}"), dom_id: '#docsy_swagger_ui', presets: [ SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset ] }); window.ui = ui; }; </script> https://docs.microservice-dungeon.de/docs/reference/map-service/asyncapi/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.microservice-dungeon.de/docs/reference/map-service/asyncapi/ <style> #open_asyncapi .sidebar--wrapper { position: sticky !important; top: 0 !important; max-height: 100vh; overflow-y: auto; } #open_asyncapi .asyncapi { display: flex; flex-direction: row; overflow: hidden; width: 100%; } #open_asyncapi .asyncapi__main { flex: 1 1 0%; overflow-y: auto; max-height: 100vh; } #open_asyncapi .aui-root .container\:base .sidebar { height: min-content; !important; } </style> <div id="open_asyncapi"></div> <script> window.onload = function () { const sourceUrl = "\"https://gitlab.com/api/v4/projects/75033698/repository/files/docs%2Fasyncapi.yaml?ref=main\""; const schemaYaml = "asyncapi: 3.0.0\n\ninfo:\n title: Map-Service Kafka Producer API\n version: 1.0.0\n\nchannels:\n db.map.ecst.v1:\n address: 'db.map.ecst.v1'\n title: 'Map ECST'\n description: Log compacted topic transferring the map's current state.\n messages:\n map.state-transfer:\n $ref: '#/components/messages/map.state-transfer'\n\n bl.map.events.v1:\n address: 'bl.map.events.v1'\n title: 'Map Events'\n description: Notifies about map updates.\n messages:\n map.created:\n $ref: '#/components/messages/map.created'\n\noperations:\n sendMapECST:\n channel:\n $ref: '#/channels/db.map.ecst.v1'\n action: send\n description: Publishes the map's entire state on creation.\n messages:\n - $ref: '#/channels/db.map.ecst.v1/messages/map.state-transfer'\n\n sendMapCreated:\n channel:\n $ref: '#/channels/bl.map.events.v1'\n action: send\n description: A new map has been created.\n messages:\n - $ref: '#/channels/bl.map.events.v1/messages/map.created'\n\ncomponents:\n schemas:\n mapId:\n type: string\n format: uuid\n description: A map's unique id.\n\n gameId:\n type: string\n format: uuid\n description: The game this map belongs to.\n\n mapName:\n type: string\n description: The name of the map.\n example: Tiny Map\n\n mapDescription:\n type: string\n description: A human-readable description of the map.\n nullable: true\n\n coordinate:\n type: string\n description: A coordinate on the map grid in \"(x,y)\" format.\n pattern: '^\\(\\d+,\\d+\\)$'\n examples:\n - '(0,0)'\n - '(2,2)'\n\n gravity:\n type: string\n description: The gravity level of a planet affecting movement energy cost.\n enum:\n - light\n - medium\n - intense\n\n planetType:\n type: string\n description: The type of a planet or void cell.\n enum:\n - empty\n - spaceStation\n - resourceMine\n - blackHole\n - void\n\n planet:\n type: object\n description: A planet or void cell on the map grid.\n required:\n - coordinate\n - type\n properties:\n coordinate:\n $ref: '#/components/schemas/coordinate'\n type:\n $ref: '#/components/schemas/planetType'\n allowsRobotSpawns:\n type: boolean\n description: Whether robots can be spawned at this station. Only present on spaceStation planets.\n nullable: true\n resource:\n type: string\n description: 'Mineable resource in \"amount key\" format (e.g. \"2000 id\"). Only present on resourceMine planets.'\n nullable: true\n examples:\n - '2000 id'\n - '5000 cg'\n blackHoleEnergyDrainPercentage:\n type: integer\n description: Percentage of energy drained when passing through (0-100). Only present on blackHole planets.\n nullable: true\n minimum: 0\n maximum: 100\n examples:\n - 50\n gravity:\n $ref: '#/components/schemas/gravity'\n\n messageTraits:\n commonHeaders:\n headers:\n type: object\n properties:\n event_id:\n type: string\n format: uuid\n description: |\n Identifies the event uniquely across topics and partitions by id, regardless of its schema.\n Can therefore be used reliably to detect duplicates - in case, the same event has been published more than once.\n See the Outbox Pattern for a detailed explaination why that may be the case.\n Serialized as `UTF-8`.\n examples:\n - a7a26ff2-e851-45b6-9634-d595f45458b7\n entity:\n type: string\n description: |\n Identifies the entity the event belongs to by name and id - if that is even possible.\n Should only be used for debugging purposes.\n Serialized as `UTF-8` in `\u003centity\u003e.\u003cid\u003e` format.\n examples:\n - map.a7a26ff2-e851-45b6-9634-d595f45458b7\n sequence_id:\n type: integer\n format: int64\n description: |\n Identifies the sequence in which events where are written to the Outbox per partition.\n Consumers may use this number to filter for duplicates, as new events will always have a higher number than previous events.\n Serialized as `BIG_ENDIAN`.\n minimum: 1\n examples:\n - 1277129\n created_at:\n type: integer\n format: int64\n description: |\n Identifies the exact point in time the event was written to the Outbox, independent of the system's time zone.\n Serialized as `BIG_ENDIAN` as epoch millis.\n examples:\n - 1700000000000\n event_type:\n type: string\n description: |\n Identifies the schema used for generating the payload.\n Contains a String that matches the schema's name (or Message-ID in AsyncAPI terms).\n Does not include a version.\n Serialized as `UTF-8`.\n examples:\n - map.state-transfer\n - map.created\n event_type_version:\n type: integer\n description: |\n Identifies the schema's version the payload was generated with.\n Each AsyncAPI message contains its version as part of its name, for example: Map ECST V1;\n 1 is the message's version.\n Serialized as `BIG_ENDIAN`.\n minimum: 1\n examples:\n - 1\n\n messages:\n map.state-transfer:\n name: 'map.state-transfer'\n title: Map ECST V1\n summary: Describes the map\n description: Keyed ECST event publishing the map's current state.\n contentType: application/json\n traits:\n - $ref: '#/components/messageTraits/commonHeaders'\n payload:\n type: object\n properties:\n id:\n $ref: '#/components/schemas/mapId'\n gameId:\n $ref: '#/components/schemas/gameId'\n name:\n $ref: '#/components/schemas/mapName'\n description:\n $ref: '#/components/schemas/mapDescription'\n topRight:\n $ref: '#/components/schemas/coordinate'\n planets:\n type: array\n items:\n $ref: '#/components/schemas/planet'\n examples:\n - name: Very Small Map (3x3)\n payload:\n id: '497f6eca-6276-4993-bfeb-53cbbbba6f08'\n gameId: 'b3d7c8a1-4e2f-4f9a-8c6d-1a2b3c4d5e6f'\n name: Tiny Map\n description: 'A tiny map (3x3, from (0,0) to (2,2)) intended to serve as just an example for an event payload.'\n topRight: '(2,2)'\n planets:\n - coordinate: '(0,0)'\n type: spaceStation\n allowsRobotSpawns: true\n gravity: light\n - coordinate: '(0,1)'\n type: empty\n gravity: medium\n - coordinate: '(0,2)'\n type: resourceMine\n resource: '2000 id'\n gravity: intense\n - coordinate: '(1,0)'\n type: void\n - coordinate: '(1,1)'\n type: resourceMine\n resource: '5000 cg'\n gravity: medium\n - coordinate: '(1,2)'\n type: blackHole\n blackHoleEnergyDrainPercentage: 50\n gravity: intense\n - coordinate: '(2,0)'\n type: void\n - coordinate: '(2,1)'\n type: spaceStation\n allowsRobotSpawns: false\n gravity: medium\n - coordinate: '(2,2)'\n type: empty\n gravity: intense\n\n map.created:\n name: 'map.created'\n title: Map Created V1\n summary: New map created\n description: Notifies about the creation of a new map from a template.\n contentType: application/json\n traits:\n - $ref: '#/components/messageTraits/commonHeaders'\n payload:\n type: object\n properties:\n id:\n $ref: '#/components/schemas/mapId'\n gameId:\n $ref: '#/components/schemas/gameId'\n name:\n $ref: '#/components/schemas/mapName'\n description:\n $ref: '#/components/schemas/mapDescription'\n topRight:\n $ref: '#/components/schemas/coordinate'\n planets:\n type: array\n items:\n $ref: '#/components/schemas/planet'\n examples:\n - name: Very Small Map (3x3)\n payload:\n id: '497f6eca-6276-4993-bfeb-53cbbbba6f08'\n gameId: 'b3d7c8a1-4e2f-4f9a-8c6d-1a2b3c4d5e6f'\n name: Very Small Map\n description: 'A very small map (3x3, from (0,0) to (2,2)) intended to serve as just an example for an event payload.'\n topRight: '(2,2)'\n planets:\n - coordinate: '(0,0)'\n type: spaceStation\n allowsRobotSpawns: true\n gravity: light\n - coordinate: '(0,1)'\n type: empty\n gravity: medium\n - coordinate: '(0,2)'\n type: resourceMine\n resource: '2000 id'\n gravity: intense\n - coordinate: '(1,0)'\n type: void\n - coordinate: '(1,1)'\n type: resourceMine\n resource: '5000 cg'\n gravity: medium\n - coordinate: '(1,2)'\n type: blackHole\n blackHoleEnergyDrainPercentage: 50\n gravity: intense\n - coordinate: '(2,0)'\n type: void\n - coordinate: '(2,1)'\n type: spaceStation\n allowsRobotSpawns: false\n gravity: medium\n - coordinate: '(2,2)'\n type: empty\n gravity: intense\n"; console.debug("[asyncapi-render] sourceUrl:", sourceUrl); console.debug("[asyncapi-render] schemaYaml length:", schemaYaml.length); console.debug("[asyncapi-render] schemaYaml preview:", schemaYaml.slice(0, 200)); const ui = AsyncApiStandalone.render({ schema: schemaYaml, config: { show: { sidebar: true } } }, document.getElementById("open_asyncapi")); window.ui = ui; console.debug("[asyncapi-render] UI instance:", ui); }; </script>