autogen(docs): generate and format documentation

ory · Apr 23, 2021 · af6beb8 · af6beb8
1 parent e3d9158
commit af6beb8
Show file tree

Hide file tree

Showing 2 changed files with 79 additions and 23,045 deletions.
diff --git a/docs/docs/reference/api.mdx b/docs/docs/reference/api.mdx
@@ -4781,12 +4781,12 @@ the subject accepted or rejected the request.
 
 ##### Overview
 
-| Status | Meaning | Description | Schema |
-| ------ | -------------------------------------------------------------------------- | -------------- | --------------------------------------- |
-| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | consentRequest | [consentRequest](#schemaconsentrequest) |
-| 404 | [Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4) | genericError | [genericError](#schemagenericerror) |
-| 409 | [Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8) | genericError | [genericError](#schemagenericerror)  |
-| 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | genericError | [genericError](#schemagenericerror) |
+| Status | Meaning | Description  | Schema  |
+| ------ | -------------------------------------------------------------------------- | ------------------------- | ------------------------------------------------------------- |
+| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | consentRequest  | [consentRequest](#schemaconsentrequest)  |
+| 404 | [Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4) | genericError  | [genericError](#schemagenericerror)  |
+| 410 | [Gone](https://tools.ietf.org/html/rfc7231#section-6.5.9)   | requestWasHandledResponse | [requestWasHandledResponse](#schemarequestwashandledresponse) |
+| 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | genericError  | [genericError](#schemagenericerror)  |
 
 ##### Examples
 
@@ -5456,13 +5456,13 @@ the requested authentication process.
 
 ##### Overview
 
-| Status | Meaning | Description | Schema |
-| ------ | -------------------------------------------------------------------------- | ------------ | ----------------------------------- |
-| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | loginRequest | [loginRequest](#schemaloginrequest) |
-| 400 | [Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1) | genericError | [genericError](#schemagenericerror) |
-| 404 | [Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4) | genericError | [genericError](#schemagenericerror) |
-| 409 | [Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8) | genericError | [genericError](#schemagenericerror) |
-| 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | genericError | [genericError](#schemagenericerror) |
+| Status | Meaning | Description  | Schema  |
+| ------ | -------------------------------------------------------------------------- | ------------------------- | ------------------------------------------------------------- |
+| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | loginRequest  | [loginRequest](#schemaloginrequest)  |
+| 400 | [Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1) | genericError  | [genericError](#schemagenericerror)  |
+| 404 | [Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4) | genericError  | [genericError](#schemagenericerror)  |
+| 410 | [Gone](https://tools.ietf.org/html/rfc7231#section-6.5.9)  | requestWasHandledResponse | [requestWasHandledResponse](#schemarequestwashandledresponse) |
+| 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | genericError  | [genericError](#schemagenericerror)  |
 
 ##### Examples
 
@@ -6104,11 +6104,12 @@ Use this endpoint to fetch a logout request.
 
 ##### Overview
 
-| Status | Meaning | Description | Schema |
-| ------ | -------------------------------------------------------------------------- | ------------- | ------------------------------------- |
-| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | logoutRequest | [logoutRequest](#schemalogoutrequest) |
-| 404 | [Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4) | genericError | [genericError](#schemagenericerror) |
-| 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | genericError | [genericError](#schemagenericerror) |
+| Status | Meaning | Description | Schema |
+| ------ | -------------------------------------------------------------------------- | ------------------------- | ------------------------------------------------------------- |
+| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | logoutRequest | [logoutRequest](#schemalogoutrequest) |
+| 404 | [Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4) | genericError | [genericError](#schemagenericerror) |
+| 410 | [Gone](https://tools.ietf.org/html/rfc7231#section-6.5.9) | requestWasHandledResponse | [requestWasHandledResponse](#schemarequestwashandledresponse) |
+| 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | genericError | [genericError](#schemagenericerror) |
 
 ##### Examples
 
@@ -8238,6 +8239,7 @@ _NullTime implements sql.NullTime functionality._
  }
  ],
  "Interface": {
+ "ProtocolScheme": "string",
  "Socket": "string",
  "Types": [
  {
@@ -8345,6 +8347,7 @@ _PluginConfigArgs plugin config args_
 
 ```json
 {
+ "ProtocolScheme": "string",
  "Socket": "string",
  "Types": [
  {
@@ -8360,10 +8363,11 @@ _PluginConfigInterface The interface between Docker and the plugin_
 
 #### Properties
 
-| Name | Type | Required | Restrictions | Description |
-| ------ | --------------------------------------------------- | -------- | ------------ | ----------- |
-| Socket | string | true | none | socket |
-| Types | [[PluginInterfaceType](#schemaplugininterfacetype)] | true | none | types |
+| Name | Type | Required | Restrictions | Description |
+| -------------- | --------------------------------------------------- | -------- | ------------ | ----------------------------------------------------- |
+| ProtocolScheme | string | false | none | Protocol to use for clients connecting to the plugin. |
+| Socket | string | true | none | socket |
+| Types | [[PluginInterfaceType](#schemaplugininterfacetype)] | true | none | types |
 
 <a id="tocSpluginconfiglinux"></a>
 
@@ -9452,6 +9456,27 @@ _The request payload used to accept a login or consent request._
 | error_hint | string | false | none | Hint to help resolve the error. |
 | status_code | integer(int64) | false | none | Represents the HTTP status code of the error (e.g. 401 or 403)<br/><br/>Defaults to 400 |
 
+<a id="tocSrequestwashandledresponse"></a>
+
+#### requestWasHandledResponse
+
+<a id="schemarequestwashandledresponse"></a>
+
+```json
+{
+ "redirect_to": "string"
+}
+```
+
+_The response payload sent when there is an attempt to access already handled
+request._
+
+#### Properties
+
+| Name | Type | Required | Restrictions | Description |
+| ----------- | ------ | -------- | ------------ | ------------------------------------------------------------------------------------------ |
+| redirect_to | string | true | none | Original request URL to which you should redirect the user if request was already handled. |
+
 <a id="tocSuserinforesponse"></a>
 
 #### userinfoResponse