mirror of
https://github.com/goauthentik/authentik
synced 2026-04-26 17:45:21 +02:00
first pass
This commit is contained in:
Tana M Berry
@@ -0,0 +1,657 @@
|
||||
---
|
||||
id: flows-bindings-retrieve
|
||||
title: "flows_bindings_retrieve"
|
||||
description: "FlowStageBinding Viewset"
|
||||
sidebar_label: "flows_bindings_retrieve"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJy1WOtv2zYQ/1cIYcA2zLGzNFu7fFrWuJ2B9IHY6R5ZJtDS2eIskSpJ2XED/++7IylbfsROi+aDYYqPe9/vjryPVAmaW6FkL43OolGuZiYeCpkKOTaxBqsFTCFqRSmYRIuSduK+V7ivb/kYfvNb2QcBMwMWN5Zc8wIsaBOd3dxHgraX3Ga4JHGBmJhhXFUixRmTZFDw6Ow+svOS1gwylGNcGSldcIszbudiU4Bzdn3du2B+OxMpSCtGcxrbTBhG8jEnIAsStpGmho+V0ICKWl3B4rYV4Q4S0+sd4YSBpNLCzp3svLIZEZ7g1y1t12BKJQ0Ykvjk+Jj+EiUtbqIhL8tcJM6anf8MyXm/raEa/geJPWzRPmjBc/EJNBlVk5+s8JzLyWGLkbA8fSfzudcWdRU2pwOvzJDVRi0VCjwP/i5UCnlcWh3j4mczWJA19Rjso7xpSNXH74zRas7Cef5u5Hyz35re9U9mQk++ltCH9SY1XEhUgeESgmOT17rAr8EyrwujjcwoDGRu2QzYRGIsZ/izikEqcEMGbKn3lhOmoIfKQLxbqk2+V2ArLQO5bw1bO32Aelzmleb55zPx5w7yQhThsQ/Kz1JGYEJqiQzcWfYQecr52KzFK9eaz3GvsFCYwznbRzHKElKWqplkRI+ZJ8taov40aftg/Jq8Gh+2+gdhxDAHNLuLzOurS8Lagt9dghwj7p/9dExVwZJTcPu/N0f86NP50d/HR7/Etz98Q4yCkoc49TOyMzeOz4DOEFNnmRIT0rRDnRBjyf2RJmKArArC+hrVPVAjE5pQWnyqv4WcogvT+hOkVnleUBq3okqufWpIFIYxxYzHKawGIzGufEmlgrKpUdOfFytRuyQclZh1jS8gwdpm2IywYFXZ8L8yGHfo2jZ7pTSDO16UObScZc7XFPRxiSew8GHxI4BRSA/QkJJV8qhhDqSIZDWboketYcvy5+w65MlkrFUldwbZNpqFWCBuNFwdZ6JAS7VZb+QWKPpIvA4aEKVgqA2ONPKfCZuxzNryH4mo5zSg/EYpuTkSZlco+8SIMfCEBIcdJOzS83lO7pbzfY5570h0HYU3RCAAOQo3FDm2BkuygcJQqRy43DJCV3JKi7WzDpJaGLUJio59xMaq07jkxsyUTlnBJRpKG4ZOLBRuAZbCVCQh0OGuVNrGlX4EApND/H7nE4wbFxa7TJjzuaps02zojmQCBB2h14lzGNnGpxbjjL4NxuqQ63q5/vTLB3Lh0rH1aUDSSwFpzJOH07gAY0LGWSErgvgwFSRzk3u4Xjge58me9HsZshl8AppMVXnKMuzzMH18Dvn0cvJixiToHEMhz10moZ8WzbbzpplF61C15s+AyS2qGfvQPkB0rdPtukn7WNsWmwKsepLtArvOdqM876r8txstUeSb5I2IAoTTCtElVhIPcvmY3AlHmNOdTJtW2nf3EAAfCUmawSJLRncpoSFeMqtPfhE351vi5Ts9xJ4Se3+0Wg1nwbutCBMVa/2KBzUfY1f9sQKKgmL15MfT56cvnv18+hwnhfSTR8vZF0+HW6GSxfW9ZW9C0WVv7hDB4e9qFBMsuTyDu7153PPsrgK3R6aWa23RpC6R4A4vYJZqQJ1rMkXc49TVOeKs1sVnWZKhImg2rCdX3cHVX6FG+BYBtEZKARWQBhYOZkQhcq5XB2uP1pyJUH9wfjVgQX2zkm6kVeGrGaCZKfxajmw4Ef/RG/wev3z3dtD9c9fxWUYYPgEo61DGy6amqArG3cYLH16PAQLrkW91XVrexzZhoXHL9Piw7hkKnNOverf9sGynWJdcstUaS0SGkYA8jZ3LzCNa8rpLddU53dW/4gpP8b6EbHn+vslv1XE2RPOSPWiPZ1/RHq9B4jUhYefvew8YJEVkFjvq+l5tm3ETCDRcH5juUdNfuTJFD0Hj8JZD/XvUcc8jnfpZqHNfv+AsOhRxoKf1a49rRqIOL0Vn+qzj0r5+UemTcbx2jXeVpR7U59UPQg6rgWvQTighR8rtDJqsjruqZLz8J8cnp+0X7ZMta7/hE0q39bafcAAb5nboFRAXHeAWzupRBnmufh2rVQcsFNkePQ4IPS5k/VvWm96AbgVObVLBnHU6Y4TLatjGSttpkOisRsNcDTvISnYuey+7b/tdp2apjC18dawfysjsrDY7e+g1rhGX+x7mgqEJZzpYPYUkjUL36B1dv4Nhsx944vCs8VxH8ZShmLT1/n6IHey1zhcLmv5Y0TXo7AaHU4534CG5CiMiFYbGGFMjnhvYI/p3VyF+v2df9Lq3U78aRSRhCJV5+sLhBObNl8jFLe7NsHGhWo5S++VzbOdK2zi4lfQU4Muced0dhNtks+fwcdyqB423q3Wh0J5ux0BNQKJNaxktfZOAi8X/I0STLg==
|
||||
sidebar_class_name: "get 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={"flows_bindings_retrieve"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/flows/bindings/{fsb_uuid}/"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
FlowStageBinding 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":"fsb_uuid","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this Flow Stage Binding.","required":true}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><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={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid","readOnly":true,"title":"Fsb uuid"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"policybindingmodel_ptr_id"}
|
||||
required={true}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"target"}
|
||||
required={true}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"stage"}
|
||||
required={true}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
stage_obj
|
||||
</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"}}
|
||||
>
|
||||
|
||||
|
||||
Stage Serializer
|
||||
|
||||
|
||||
</div><SchemaItem
|
||||
collapsible={false}
|
||||
name={"pk"}
|
||||
required={true}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid","readOnly":true,"title":"Stage uuid"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"component"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Get object type 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={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
flow_set
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
object[]
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
|
||||
>
|
||||
Array [
|
||||
</div>
|
||||
</li><SchemaItem
|
||||
collapsible={false}
|
||||
name={"pk"}
|
||||
required={true}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid","readOnly":true,"title":"Flow uuid"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"policybindingmodel_ptr_id"}
|
||||
required={true}
|
||||
schemaName={"uuid"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"uuid","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</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":"Visible in the URL.","maxLength":50,"pattern":"^[-a-zA-Z0-9_]+$"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"title"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Shown as the Title in Flow pages."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"designation"}
|
||||
required={true}
|
||||
schemaName={"FlowDesignationEnum (string)"}
|
||||
qualifierMessage={"**Possible values:** [`authentication`, `authorization`, `invalidation`, `enrollment`, `unenrollment`, `recovery`, `stage_configuration`]"}
|
||||
schema={{"description":"Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.","enum":["authentication","authorization","invalidation","enrollment","unenrollment","recovery","stage_configuration"],"type":"string","title":"FlowDesignationEnum"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"background"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Get the URL to the background image. If the name is /static or starts with http\nit is returned as-is","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={"compatibility_mode"}
|
||||
required={false}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean","description":"Enable compatibility mode, increases compatibility with password managers on mobile devices."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"export_url"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","description":"Get export URL for flow","readOnly":true}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"layout"}
|
||||
required={false}
|
||||
schemaName={"FlowLayoutEnum (string)"}
|
||||
qualifierMessage={"**Possible values:** [`stacked`, `content_left`, `content_right`, `sidebar_left`, `sidebar_right`]"}
|
||||
schema={{"enum":["stacked","content_left","content_right","sidebar_left","sidebar_right"],"type":"string","title":"FlowLayoutEnum"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"denied_action"}
|
||||
required={false}
|
||||
schemaName={"DeniedActionEnum (string)"}
|
||||
qualifierMessage={"**Possible values:** [`message_continue`, `message`, `continue`]"}
|
||||
schema={{"description":"Configure what should happen when a flow denies access to a user.","enum":["message_continue","message","continue"],"type":"string","title":"DeniedActionEnum"}}
|
||||
>
|
||||
|
||||
</SchemaItem><li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
|
||||
>
|
||||
]
|
||||
</div>
|
||||
</li>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"evaluate_on_plan"}
|
||||
required={false}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean","description":"Evaluate policies during the Flow planning process."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"re_evaluate_policies"}
|
||||
required={false}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean","description":"Evaluate policies when the Stage is present to the user."}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"order"}
|
||||
required={true}
|
||||
schemaName={"integer"}
|
||||
qualifierMessage={"**Possible values:** `>= -2147483648` and `<= 2147483647`"}
|
||||
schema={{"type":"integer","maximum":2147483647,"minimum":-2147483648}}
|
||||
>
|
||||
|
||||
</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={"invalid_response_action"}
|
||||
required={false}
|
||||
schemaName={"InvalidResponseActionEnum (string)"}
|
||||
qualifierMessage={"**Possible values:** [`retry`, `restart`, `restart_with_context`]"}
|
||||
schema={{"enum":["retry","restart","restart_with_context"],"type":"string","title":"InvalidResponseActionEnum"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"policybindingmodel_ptr_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"target\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"stage\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"stage_obj\": {\n \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"component\": \"string\",\n \"verbose_name\": \"string\",\n \"verbose_name_plural\": \"string\",\n \"meta_model_name\": \"string\",\n \"flow_set\": [\n {\n \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"policybindingmodel_ptr_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"title\": \"string\",\n \"designation\": \"authentication\",\n \"background\": \"string\",\n \"policy_engine_mode\": \"all\",\n \"compatibility_mode\": true,\n \"export_url\": \"string\",\n \"layout\": \"stacked\",\n \"denied_action\": \"message_continue\"\n }\n ]\n },\n \"evaluate_on_plan\": true,\n \"re_evaluate_policies\": true,\n \"order\": 0,\n \"policy_engine_mode\": \"all\",\n \"invalid_response_action\": \"retry\"\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