mirror of
https://github.com/goauthentik/authentik
synced 2026-04-26 09:35:07 +02:00
first pass
This commit is contained in:
@@ -0,0 +1,603 @@
|
||||
---
|
||||
id: sources-user-connections-saml-partial-update
|
||||
title: "sources_user_connections_saml_partial_update"
|
||||
description: "Source Viewset"
|
||||
sidebar_label: "sources_user_connections_saml_partial_update"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJy9WFtv2zYU/iuEMGAb5lhZ2gFbnpZlWWugaYMkLbB1nkBbtM2GIlWSiuMa+u/7DinZ8iVJA2R7SSST5/6dm5aJKYXlXho9yJPjxJnKjoXLKidsNjZaizGduczxQmUlt15ylVVlzr1Iekku3NjKkq6A+CoQsw9SzJ3wOMZ9XggvrEuOPy4TSZdK7mc40jjAm8zx7MYzUfDkeJn4RRl+1V5MhU3qbQknrNLycyVYc4PdckVvudBeThZST5mfScfeQ312dXL+hjU6na5M6UOgFZ8raQUM9rYS9bCXeD4lHVv7k2G8JJz/zeQLUg3O8JBCj7wslRwHp6WfHCm23LXBjD5B4K6POkpdCQtvyi+wFL6yFAkvIRxMGoskjtYsnbewEHcLqd8IPYUjj3+s4SQvvaILF9xDjZysJzlRzNr0y2hRUtdE5MS4stIvQmh45Wck8QZvwzpY70rEPWpzdHj4/7ugvNmDCFKM5++0WsTYrW0f/E5wIdx+BRmZHxQItij1bhK88IjeT1N5Fa2JsQWH15KqCnC/z4KLUcHClbpNj11e+zT61rFculLxBXsLsj7RO1VNH6cfwD1Wc8WiMxhJ7TH4MEeCsfeXbxxlS8HvWrT9dEhJ7YkK5P98POAHX04O/jo8+CUb/vANCRaajxRl1kr2yBgluKbDFmURONlEmfnXOExXShHX1mGbRvwBLswbUpvNwZ51paAgiDvpwgNhw/WjktYoVeDSf6VDlEBStZh3JIe62oBmkRVII9xxHQW4tXwBedKLwj2uGCXy1JqqfG6mY1Mg/5tsfxhFr4RnMWXYigqIQiXmns0Fu9Fwziw6SOTS40CwVY7tJOatsCPjRPZ1KXApfGV1ww6ZsEH9CPesVJXl6ulCIt2jstD6eFaYXKinGSPbtAy07D72pUEJXmRITalFkEMShK4K6mSoaiDiekG9bFvsquQEFmeBwzkxaCFaUCfB3RXbdZFsBXRaFDKq4FJlAPzN6gXHhDliF5zdHK7ew/kDulEXO2/UIN3OSC61pk2fvSZgAVBNCctp3EB/FI7JCeN6M/2Zm5lK5WwkulUC5c5Yxlep2mSvyEPKFlzz6UZFW6m6XRRa1c8jCRst2Lqxbiv+LqDJxTThVrBiD1WfXc+Ea9PFhXtjIIF05jpncRLLicAgZrBGqQURYQiaKD5lBogBoPJgZytMr/IVj/CFAZLnmAXQ3Ul6IadxJHR99qepwi34UAVAYszqJDASTvLwfnIx6LFR5eHwMrCecT0liWZbAloLZwrq2Eb9/j50x0qJYTFD0Srp+m4EcE2O4/DxWGh2SxYpjRZHCtLjAIz6bDAJLwRQBhemzpNTAY+/NR4t7J1LP2Mz70uGSoYrNuQshcAdSLdrSd0dNz926mqj+xpguwWjmQN6NFg0PX2rPu4vaMM1FOOIkMSRbsvFDZAebAgUnwMv91egh6bUHcMbYb3NwhEti0o249twswbsm2STMMFuxpTQ8PJZB9UPGPPyQMrOrDW7856mIUYKlWeCzp/QcmOLzfdhmuakHG0SYrm66MrrTPpr1aJm9/rjxTP645XQmH3HlOr3OATVF6V/b6Leb20XJQ2DDgQaoQ+YGTvtzORxuxzPwuZJ42qSNvtcur3PprTPpkuZ1ynhT9jbdkmtrCJCXsr09kUaEqfdlK7IT9HQzr60MomKQrvNhsFXoFrboB95+nK9T57dcZQ0sb3odcuanpjAuvFCt42QqtH2o8Ojl/2f+0c7kTrnN9TyNudt5iRJpWpLgODjAIjQrEl7oZT5dWrWrUca0gRoEdgDA9zjzn4+uKZUDX4im91xmk5RFatRH9Ut7bBI108jZUYpROn0zeD07O3VWfBLaZxH+eswbwIW+3AnYIwCxpoPEGz/B4gO0He/RTRB8uLOp2gnMiwkwYhlg5b19t90n454iisUwL/jsA4QQmdQnqiWyxF34r1VdU0/I8qWlmo83nKsiqEJAVjY0ZrVaMKV225JXd2/u2wy4nv2TB889hrfVqowpgW+lE695EYs4peZeohbMxR9AicsiAenUc+DayJfE+4UlrrXUpyMx6L0D94ddnL44uT69DVuj5ovL3EETSyfUw/C36ClKWNgcCH8tkwUBo4KnRTnkWndrJzdZTTmZK996Gz9m35AUMONa3MjNALbusXTO3mmrv8FCkG49A==
|
||||
sidebar_class_name: "patch api-method"
|
||||
info_path: docs/developer-docs/api/reference/authentik
|
||||
custom_edit_url: null
|
||||
hide_send_button: true
|
||||
---
|
||||
|
||||
import ApiTabs from "@theme/ApiTabs";
|
||||
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
||||
import MimeTabs from "@theme/MimeTabs";
|
||||
import ParamsItem from "@theme/ParamsItem";
|
||||
import ResponseSamples from "@theme/ResponseSamples";
|
||||
import SchemaItem from "@theme/SchemaItem";
|
||||
import SchemaTabs from "@theme/SchemaTabs";
|
||||
import Heading from "@theme/Heading";
|
||||
import OperationTabs from "@theme/OperationTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
|
||||
<Heading
|
||||
as={"h1"}
|
||||
className={"openapi__heading"}
|
||||
children={"sources_user_connections_saml_partial_update"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"patch"}
|
||||
path={"/sources/user_connections/saml/{id}/"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Source Viewset
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<details
|
||||
style={{"marginBottom":"1rem"}}
|
||||
className={"openapi-markdown__details"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<h3
|
||||
className={"openapi-markdown__details-summary-header-params"}
|
||||
>
|
||||
Path Parameters
|
||||
</h3>
|
||||
</summary><div>
|
||||
<ul>
|
||||
<ParamsItem
|
||||
className={"paramsItem"}
|
||||
param={{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this User SAML Source Connection.","required":true}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><MimeTabs
|
||||
className={"openapi-tabs__mime"}
|
||||
>
|
||||
<TabItem
|
||||
label={"application/json"}
|
||||
value={"application/json-schema"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details mime"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
className={"openapi-markdown__details-summary-mime"}
|
||||
>
|
||||
<h3
|
||||
className={"openapi-markdown__details-summary-header-body"}
|
||||
>
|
||||
Body
|
||||
</h3>
|
||||
</summary><div
|
||||
style={{"textAlign":"left","marginLeft":"1rem"}}
|
||||
>
|
||||
|
||||
</div><ul
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"identifier"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** `non-empty`"}
|
||||
schema={{"type":"string","minLength":1}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem>
|
||||
</MimeTabs><div>
|
||||
<div>
|
||||
<ApiTabs
|
||||
label={undefined}
|
||||
id={undefined}
|
||||
>
|
||||
<TabItem
|
||||
label={"200"}
|
||||
value={"200"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div><div>
|
||||
<MimeTabs
|
||||
className={"openapi-tabs__mime"}
|
||||
schemaType={"response"}
|
||||
>
|
||||
<TabItem
|
||||
label={"application/json"}
|
||||
value={"application/json"}
|
||||
>
|
||||
<SchemaTabs
|
||||
className={"openapi-tabs__schema"}
|
||||
>
|
||||
<TabItem
|
||||
label={"Schema"}
|
||||
value={"Schema"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details response"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
className={"openapi-markdown__details-summary-response"}
|
||||
>
|
||||
<strong>
|
||||
Schema
|
||||
</strong>
|
||||
</summary><div
|
||||
style={{"textAlign":"left","marginLeft":"1rem"}}
|
||||
>
|
||||
|
||||
</div><ul
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"pk"}
|
||||
required={true}
|
||||
schemaName={"ID (integer)"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","readOnly":true,"title":"ID"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"user"}
|
||||
required={true}
|
||||
schemaName={"integer"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
source
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
object
|
||||
</span><span
|
||||
className={"openapi-schema__divider"}
|
||||
>
|
||||
|
||||
</span><span
|
||||
className={"openapi-schema__required"}
|
||||
>
|
||||
required
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<div
|
||||
style={{"marginTop":".5rem","marginBottom":".5rem"}}
|
||||
>
|
||||
|
||||
|
||||
Source Serializer
|
||||
|
||||
|
||||
</div><SchemaItem
|
||||
collapsible={false}
|
||||
name={"pk"}
|
||||
required={true}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid","readOnly":true,"title":"Pbm uuid"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Source's display Name."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"slug"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** `<= 50 characters`, Value must match regular expression `^[-a-zA-Z0-9_]+$`"}
|
||||
schema={{"type":"string","description":"Internal source name, used in URLs.","maxLength":50,"pattern":"^[-a-zA-Z0-9_]+$"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"enabled"}
|
||||
required={false}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"authentication_flow"}
|
||||
required={false}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid","nullable":true,"description":"Flow to use when authenticating existing users."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"enrollment_flow"}
|
||||
required={false}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid","nullable":true,"description":"Flow to use when enrolling new users."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"user_property_mappings"}
|
||||
required={false}
|
||||
schemaName={"uuid[]"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"array","items":{"type":"string","format":"uuid"}}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"group_property_mappings"}
|
||||
required={false}
|
||||
schemaName={"uuid[]"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"array","items":{"type":"string","format":"uuid"}}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"component"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Get object component so that we know how to edit the object","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"verbose_name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Return object's verbose_name","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"verbose_name_plural"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Return object's plural verbose_name","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"meta_model_name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Return internal model name","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"policy_engine_mode"}
|
||||
required={false}
|
||||
schemaName={"PolicyEngineMode (string)"}
|
||||
qualifierMessage={"**Possible values:** [`all`, `any`]"}
|
||||
schema={{"enum":["all","any"],"type":"string","title":"PolicyEngineMode"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"user_matching_mode"}
|
||||
required={false}
|
||||
schemaName={"UserMatchingModeEnum (string)"}
|
||||
qualifierMessage={"**Possible values:** [`identifier`, `email_link`, `email_deny`, `username_link`, `username_deny`]"}
|
||||
schema={{"description":"How the source determines if an existing user should be authenticated or a new user enrolled.","enum":["identifier","email_link","email_deny","username_link","username_deny"],"type":"string","title":"UserMatchingModeEnum"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"managed"}
|
||||
required={true}
|
||||
schemaName={"Managed by authentik (string)"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","nullable":true,"title":"Managed by authentik","description":"Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"user_path_template"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"icon"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","nullable":true,"description":"Get the URL to the Icon. If the name is /static or\nstarts with http it is returned as-is","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"created"}
|
||||
required={true}
|
||||
schemaName={"date-time"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"date-time","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"identifier"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"pk\": 0,\n \"user\": 0,\n \"source\": {\n \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"enabled\": true,\n \"authentication_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"enrollment_flow\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"user_property_mappings\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ],\n \"group_property_mappings\": [\n \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n ],\n \"component\": \"string\",\n \"verbose_name\": \"string\",\n \"verbose_name_plural\": \"string\",\n \"meta_model_name\": \"string\",\n \"policy_engine_mode\": \"all\",\n \"user_matching_mode\": \"identifier\",\n \"managed\": \"string\",\n \"user_path_template\": \"string\",\n \"icon\": \"string\"\n },\n \"created\": \"2024-07-29T15:51:28.071Z\",\n \"identifier\": \"string\"\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"400"}
|
||||
value={"400"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div><div>
|
||||
<MimeTabs
|
||||
className={"openapi-tabs__mime"}
|
||||
schemaType={"response"}
|
||||
>
|
||||
<TabItem
|
||||
label={"application/json"}
|
||||
value={"application/json"}
|
||||
>
|
||||
<SchemaTabs
|
||||
className={"openapi-tabs__schema"}
|
||||
>
|
||||
<TabItem
|
||||
label={"Schema"}
|
||||
value={"Schema"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details response"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
className={"openapi-markdown__details-summary-response"}
|
||||
>
|
||||
<strong>
|
||||
Schema
|
||||
</strong>
|
||||
</summary><div
|
||||
style={{"textAlign":"left","marginLeft":"1rem"}}
|
||||
>
|
||||
|
||||
</div><ul
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"non_field_errors"}
|
||||
required={false}
|
||||
schemaName={"string[]"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"array","items":{"type":"string"}}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"code"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
name={"property name*"}
|
||||
required={false}
|
||||
schemaName={"any"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"object","description":"Validation Error","properties":{"non_field_errors":{"type":"array","items":{"type":"string"}},"code":{"type":"string"}},"additionalProperties":{},"title":"ValidationError"}}
|
||||
collapsible={false}
|
||||
discriminator={false}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"non_field_errors\": [\n \"string\"\n ],\n \"code\": \"string\"\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"403"}
|
||||
value={"403"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div><div>
|
||||
<MimeTabs
|
||||
className={"openapi-tabs__mime"}
|
||||
schemaType={"response"}
|
||||
>
|
||||
<TabItem
|
||||
label={"application/json"}
|
||||
value={"application/json"}
|
||||
>
|
||||
<SchemaTabs
|
||||
className={"openapi-tabs__schema"}
|
||||
>
|
||||
<TabItem
|
||||
label={"Schema"}
|
||||
value={"Schema"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details response"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
className={"openapi-markdown__details-summary-response"}
|
||||
>
|
||||
<strong>
|
||||
Schema
|
||||
</strong>
|
||||
</summary><div
|
||||
style={{"textAlign":"left","marginLeft":"1rem"}}
|
||||
>
|
||||
|
||||
</div><ul
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"detail"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"code"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"detail\": \"string\",\n \"code\": \"string\"\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user