55 lines
2.9 KiB
XML
55 lines
2.9 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE topic
|
|
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
|
|
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
|
|
title="Generate dynamic image for a department lane" id="getDepartmentLaneDynamicImage">
|
|
|
|
<!-- AUTO-GENERATED, DO NOT EDIT -->
|
|
<p>This endpoint documentation is generated directly from <code>openapi.yaml</code>.</p>
|
|
<chapter title="Endpoint" id="endpoint">
|
|
<code-block lang="http">GET /department/lanes/dynamic-image</code-block>
|
|
</chapter>
|
|
<chapter title="Operation" id="operation">
|
|
<p>Operation ID: <code>getDepartmentLaneDynamicImage</code></p>
|
|
<p>Returns a composed machine UI image for the specified department lane.
|
|
You can optionally highlight button indices, set the current step indicator, and toggle only-current-step mode.
|
|
</p>
|
|
</chapter>
|
|
<chapter title="Authentication" id="authentication">
|
|
<p>Security requirements:</p>
|
|
<table>
|
|
<tr><td>Scheme</td><td>Scopes</td></tr>
|
|
<tr><td>BearerAuth</td><td>-</td></tr>
|
|
</table>
|
|
</chapter>
|
|
<chapter title="Parameters" id="parameters">
|
|
<table>
|
|
<tr><td>Name</td><td>In</td><td>Required</td><td>Type</td><td>Description</td></tr>
|
|
<tr><td>department</td><td>query</td><td>yes</td><td>integer</td><td>Department ID</td></tr>
|
|
<tr><td>lane</td><td>query</td><td>yes</td><td>integer</td><td>Lane ID</td></tr>
|
|
<tr><td>buttons</td><td>query</td><td>no</td><td>oneOf</td><td>Highlighted button IDs (0-indexed). Accepts CSV, JSON array, or repeated query params.</td></tr>
|
|
<tr><td>current_step</td><td>query</td><td>no</td><td>integer</td><td>Current step indicator (non-negative integer)</td></tr>
|
|
<tr><td>only_current_step</td><td>query</td><td>no</td><td>boolean</td><td>If true, only draw the current step highlight</td></tr>
|
|
<tr><td>vehicle_type</td><td>query</td><td>no</td><td>integer</td><td>Vehicle type selection override (nullable non-negative integer)</td></tr>
|
|
</table>
|
|
</chapter>
|
|
<chapter title="Responses" id="responses">
|
|
<table>
|
|
<tr><td>Status</td><td>Description</td><td>Content Types</td></tr>
|
|
<tr><td>200</td><td>Dynamic image rendered successfully</td><td>image/png</td></tr>
|
|
<tr><td>400</td><td></td><td></td></tr>
|
|
<tr><td>401</td><td></td><td></td></tr>
|
|
<tr><td>403</td><td></td><td></td></tr>
|
|
<tr><td>404</td><td></td><td></td></tr>
|
|
</table>
|
|
<p>Schema for response <code>200</code> (<code>image/png</code>):</p>
|
|
<code-block lang="json">
|
|
{
|
|
"format": "binary",
|
|
"type": "string"
|
|
}
|
|
</code-block>
|
|
</chapter>
|
|
</topic>
|