api/documentation/topics/generated/setSelfServeLaneAllowedServices.topic

<?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="Set allowed services for a lane based on shown tasks" id="setSelfServeLaneAllowedServices">

    <!-- 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 /modules/self-serve/lane/services/allowed</code-block>
    </chapter>
    <chapter title="Operation" id="operation">
        <p>Operation ID: <code>setSelfServeLaneAllowedServices</code></p>
        <p>Updates the set of services that are allowed to be manually activated for a given self-serve lane,
derived from the tasks currently shown to the user after answering the self-serve questions.
This endpoint does not activate anything by itself; it only sets what is allowed to be activated.
</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;lane_id&quot;: {
      &quot;type&quot;: &quot;integer&quot;
    },
    &quot;task_ids&quot;: {
      &quot;description&quot;: &quot;List of task IDs that are currently shown to the user&quot;,
      &quot;items&quot;: {
        &quot;type&quot;: &quot;integer&quot;
      },
      &quot;type&quot;: &quot;array&quot;
    }
  },
  &quot;required&quot;: [
    &quot;lane_id&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>Allowed services updated</td><td>application/json</td></tr>
            <tr><td>401</td><td></td><td></td></tr>
            <tr><td>403</td><td></td><td></td></tr>
        </table>
        <p>Schema for response <code>200</code> (<code>application/json</code>):</p>
        <code-block lang="json">
{
  &quot;properties&quot;: {
    &quot;allowed_services&quot;: {
      &quot;items&quot;: {
        &quot;type&quot;: &quot;string&quot;
      },
      &quot;type&quot;: &quot;array&quot;
    },
    &quot;lane_id&quot;: {
      &quot;type&quot;: &quot;integer&quot;
    }
  },
  &quot;type&quot;: &quot;object&quot;
}
        </code-block>
    </chapter>
</topic>