53 lines
2.1 KiB
XML
53 lines
2.1 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="Create department goal" id="createDepartmentGoal">
|
|
|
|
<!-- 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 /goals/department</code-block>
|
|
</chapter>
|
|
<chapter title="Operation" id="operation">
|
|
<p>Operation ID: <code>createDepartmentGoal</code></p>
|
|
<p>Create a new department goal.
|
|
|
|
Access control:
|
|
- The provided `departments` must be a subset of the user's departments unless the user has `superuser`.
|
|
</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">
|
|
{
|
|
"$ref": "#/components/schemas/DepartmentGoalCreate"
|
|
}
|
|
</code-block>
|
|
</chapter>
|
|
<chapter title="Responses" id="responses">
|
|
<table>
|
|
<tr><td>Status</td><td>Description</td><td>Content Types</td></tr>
|
|
<tr><td>201</td><td>Department goal created successfully</td><td>application/json</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>
|
|
</table>
|
|
<p>Schema for response <code>201</code> (<code>application/json</code>):</p>
|
|
<code-block lang="json">
|
|
{
|
|
"$ref": "#/components/schemas/DepartmentGoal"
|
|
}
|
|
</code-block>
|
|
</chapter>
|
|
</topic>
|