Files
api/documentation/topics/generated/addSelfserveCondition.topic
T

80 lines
2.8 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="Add self-serve condition" id="addSelfserveCondition">
<!-- 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">POST /department/selfserve/conditions</code-block>
</chapter>
<chapter title="Operation" id="operation">
<p>Operation ID: <code>addSelfserveCondition</code></p>
<p>Add a new self-serve condition. Either provide a reusable machine_type_id or a legacy department/lane/product scope.</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="Request Body" id="request-body">
<p>Required: yes.</p>
<p>Content type: <code>application/json</code></p>
<code-block lang="json">
{
&quot;properties&quot;: {
&quot;condition_id&quot;: {
&quot;nullable&quot;: true,
&quot;type&quot;: &quot;integer&quot;
},
&quot;department&quot;: {
&quot;default&quot;: 0,
&quot;type&quot;: &quot;integer&quot;
},
&quot;description&quot;: {
&quot;type&quot;: &quot;string&quot;
},
&quot;lane&quot;: {
&quot;default&quot;: 0,
&quot;type&quot;: &quot;integer&quot;
},
&quot;machine_type_id&quot;: {
&quot;nullable&quot;: true,
&quot;type&quot;: &quot;integer&quot;
},
&quot;name&quot;: {
&quot;type&quot;: &quot;string&quot;
},
&quot;product&quot;: {
&quot;default&quot;: 0,
&quot;type&quot;: &quot;integer&quot;
}
},
&quot;required&quot;: [
&quot;name&quot;,
&quot;description&quot;
],
&quot;type&quot;: &quot;object&quot;
}
</code-block>
</chapter>
<chapter title="Responses" id="responses">
<table>
<tr><td>Status</td><td>Description</td><td>Content Types</td></tr>
<tr><td>200</td><td>Successfully added condition</td><td>application/json</td></tr>
<tr><td>400</td><td></td><td></td></tr>
<tr><td>500</td><td></td><td></td></tr>
</table>
<p>Schema for response <code>200</code> (<code>application/json</code>):</p>
<code-block lang="json">
{
&quot;$ref&quot;: &quot;#/components/schemas/DepartmentSelfserveCondition&quot;
}
</code-block>
</chapter>
</topic>