autogen(docs): generate and format documentation

ory · May 5, 2020 · 15ce3d8 · 15ce3d8
1 parent d901354
commit 15ce3d8
Show file tree

Hide file tree

Showing 12 changed files with 696 additions and 799 deletions.
diff --git a/docs/docs/guides/zero-trust-iap-proxy-identity-access-proxy.md b/docs/docs/guides/zero-trust-iap-proxy-identity-access-proxy.md
@@ -36,7 +36,7 @@ git clone https://github.com/ory/kratos.git
 # or if you have git+ssh set up:
 #  git clone git@github.com:ory/kratos.git
 cd kratos
-git checkout v0.2.0-alpha.2
+git checkout v0.2.1-alpha.1
 
 docker pull oryd/kratos:latest-sqlite
 docker pull oryd/kratos-selfservice-ui-node:latest

diff --git a/docs/docs/install.md b/docs/docs/install.md
@@ -11,7 +11,7 @@ binaries, Docker Images and support various package managers.
 We recommend using Docker to run ORY Kratos:
 
 ```shell
-$ docker pull oryd/kratos:v0.2.0-alpha.2
+$ docker pull oryd/kratos:v0.2.1-alpha.1
 $ docker run --rm -it oryd/kratos help
 ```
 
@@ -31,7 +31,7 @@ On linux, you can use `bash <(curl ...)` to fetch the latest stable binary
 using:
 
 ```shell
-$ bash <(curl https://raw.githubusercontent.com/ory/kratos/master/install.sh) -b . v0.2.0-alpha.2
+$ bash <(curl https://raw.githubusercontent.com/ory/kratos/master/install.sh) -b . v0.2.1-alpha.1
 $ ./kratos help
 ```
 

diff --git a/docs/docs/quickstart.mdx b/docs/docs/quickstart.mdx
@@ -157,7 +157,7 @@ git clone https://github.com/ory/kratos.git
 # or if you have git+ssh set up:
 #  git clone git@github.com:ory/kratos.git
 cd kratos
-git checkout v0.1.1-alpha.1
+git checkout v0.2.1-alpha.1
 make quickstart
 
 # or if you don't have make installed:

diff --git a/docs/docs/reference/api.md b/docs/docs/reference/api.md
@@ -439,11 +439,11 @@ Status Code **200**
   {
     "addresses": [
       {
-        "expires_at": "2020-04-30T11:21:09Z",
+        "expires_at": "2020-05-05T09:51:17Z",
         "id": "string",
         "value": "string",
         "verified": true,
-        "verified_at": "2020-04-30T11:21:09Z",
+        "verified_at": "2020-05-05T09:51:17Z",
         "via": "string"
       }
     ],
@@ -617,11 +617,11 @@ Learn how identities work in
 {
   "addresses": [
     {
-      "expires_at": "2020-04-30T11:21:09Z",
+      "expires_at": "2020-05-05T09:51:17Z",
       "id": "string",
       "value": "string",
       "verified": true,
-      "verified_at": "2020-04-30T11:21:09Z",
+      "verified_at": "2020-05-05T09:51:17Z",
       "via": "string"
     }
   ],
@@ -660,11 +660,11 @@ Learn how identities work in
 {
   "addresses": [
     {
-      "expires_at": "2020-04-30T11:21:09Z",
+      "expires_at": "2020-05-05T09:51:17Z",
       "id": "string",
       "value": "string",
       "verified": true,
-      "verified_at": "2020-04-30T11:21:09Z",
+      "verified_at": "2020-05-05T09:51:17Z",
       "via": "string"
     }
   ],
@@ -737,11 +737,11 @@ const fetch = require('node-fetch');
 const input = '{
   "addresses": [
     {
-      "expires_at": "2020-04-30T11:21:09Z",
+      "expires_at": "2020-05-05T09:51:17Z",
       "id": "string",
       "value": "string",
       "verified": true,
-      "verified_at": "2020-04-30T11:21:09Z",
+      "verified_at": "2020-05-05T09:51:17Z",
       "via": "string"
     }
   ],
@@ -873,11 +873,11 @@ Learn how identities work in
 {
   "addresses": [
     {
-      "expires_at": "2020-04-30T11:21:09Z",
+      "expires_at": "2020-05-05T09:51:17Z",
       "id": "string",
       "value": "string",
       "verified": true,
-      "verified_at": "2020-04-30T11:21:09Z",
+      "verified_at": "2020-05-05T09:51:17Z",
       "via": "string"
     }
   ],
@@ -1053,11 +1053,11 @@ Learn how identities work in
 {
   "addresses": [
     {
-      "expires_at": "2020-04-30T11:21:09Z",
+      "expires_at": "2020-05-05T09:51:17Z",
       "id": "string",
       "value": "string",
       "verified": true,
-      "verified_at": "2020-04-30T11:21:09Z",
+      "verified_at": "2020-05-05T09:51:17Z",
       "via": "string"
     }
   ],
@@ -1098,11 +1098,11 @@ Learn how identities work in
 {
   "addresses": [
     {
-      "expires_at": "2020-04-30T11:21:09Z",
+      "expires_at": "2020-05-05T09:51:17Z",
       "id": "string",
       "value": "string",
       "verified": true,
-      "verified_at": "2020-04-30T11:21:09Z",
+      "verified_at": "2020-05-05T09:51:17Z",
       "via": "string"
     }
   ],
@@ -1175,11 +1175,11 @@ const fetch = require('node-fetch');
 const input = '{
   "addresses": [
     {
-      "expires_at": "2020-04-30T11:21:09Z",
+      "expires_at": "2020-05-05T09:51:17Z",
       "id": "string",
       "value": "string",
       "verified": true,
-      "verified_at": "2020-04-30T11:21:09Z",
+      "verified_at": "2020-05-05T09:51:17Z",
       "via": "string"
     }
   ],
@@ -1708,10 +1708,10 @@ your application (e.g. `/login?request=abcde`).
 ```json
 {
   "active": "string",
-  "expires_at": "2020-04-30T11:21:09Z",
+  "expires_at": "2020-05-05T09:51:17Z",
   "forced": true,
   "id": "string",
-  "issued_at": "2020-04-30T11:21:09Z",
+  "issued_at": "2020-05-05T09:51:17Z",
   "methods": {
     "property1": {
       "config": {
@@ -1999,9 +1999,9 @@ your application (e.g. `/registration?request=abcde`).
 ```json
 {
   "active": "string",
-  "expires_at": "2020-04-30T11:21:09Z",
+  "expires_at": "2020-05-05T09:51:17Z",
   "id": "string",
-  "issued_at": "2020-04-30T11:21:09Z",
+  "issued_at": "2020-05-05T09:51:17Z",
   "methods": {
     "property1": {
       "config": {
@@ -2286,16 +2286,16 @@ your application (e.g. `/login?request=abcde`).
 ```json
 {
   "active": "string",
-  "expires_at": "2020-04-30T11:21:09Z",
+  "expires_at": "2020-05-05T09:51:17Z",
   "id": "string",
   "identity": {
     "addresses": [
       {
-        "expires_at": "2020-04-30T11:21:09Z",
+        "expires_at": "2020-05-05T09:51:17Z",
         "id": "string",
         "value": "string",
         "verified": true,
-        "verified_at": "2020-04-30T11:21:09Z",
+        "verified_at": "2020-05-05T09:51:17Z",
         "via": "string"
       }
     ],
@@ -2304,7 +2304,7 @@ your application (e.g. `/login?request=abcde`).
     "traits_schema_id": "string",
     "traits_schema_url": "string"
   },
-  "issued_at": "2020-04-30T11:21:09Z",
+  "issued_at": "2020-05-05T09:51:17Z",
   "methods": {
     "property1": {
       "config": {
@@ -2558,7 +2558,7 @@ your application (e.g. `/verify?request=abcde`).
 
 ```json
 {
-  "expires_at": "2020-04-30T11:21:09Z",
+  "expires_at": "2020-05-05T09:51:17Z",
   "form": {
     "action": "string",
     "errors": [
@@ -2584,7 +2584,7 @@ your application (e.g. `/verify?request=abcde`).
     "method": "string"
   },
   "id": "string",
-  "issued_at": "2020-04-30T11:21:09Z",
+  "issued_at": "2020-05-05T09:51:17Z",
   "request_url": "string",
   "success": true,
   "via": "string"
@@ -4555,16 +4555,16 @@ This endpoint is useful for reverse proxies and API Gateways.
 
 ```json
 {
-  "authenticated_at": "2020-04-30T11:21:09Z",
-  "expires_at": "2020-04-30T11:21:09Z",
+  "authenticated_at": "2020-05-05T09:51:17Z",
+  "expires_at": "2020-05-05T09:51:17Z",
   "identity": {
     "addresses": [
       {
-        "expires_at": "2020-04-30T11:21:09Z",
+        "expires_at": "2020-05-05T09:51:17Z",
         "id": "string",
         "value": "string",
         "verified": true,
-        "verified_at": "2020-04-30T11:21:09Z",
+        "verified_at": "2020-05-05T09:51:17Z",
         "via": "string"
       }
     ],
@@ -4573,7 +4573,7 @@ This endpoint is useful for reverse proxies and API Gateways.
     "traits_schema_id": "string",
     "traits_schema_url": "string"
   },
-  "issued_at": "2020-04-30T11:21:09Z",
+  "issued_at": "2020-05-05T09:51:17Z",
   "sid": "string"
 }
 ```
@@ -4946,11 +4946,11 @@ credentials, passwordless credentials,_
 {
   "addresses": [
     {
-      "expires_at": "2020-04-30T11:21:09Z",
+      "expires_at": "2020-05-05T09:51:17Z",
       "id": "string",
       "value": "string",
       "verified": true,
-      "verified_at": "2020-04-30T11:21:09Z",
+      "verified_at": "2020-05-05T09:51:17Z",
       "via": "string"
     }
   ],
@@ -5051,11 +5051,11 @@ _None_
 
 ```json
 {
-  "expires_at": "2020-04-30T11:21:09Z",
+  "expires_at": "2020-05-05T09:51:17Z",
   "id": "string",
   "value": "string",
   "verified": true,
-  "verified_at": "2020-04-30T11:21:09Z",
+  "verified_at": "2020-05-05T09:51:17Z",
   "via": "string"
 }
 ```
@@ -5354,10 +5354,10 @@ _Error response_
 ```json
 {
   "active": "string",
-  "expires_at": "2020-04-30T11:21:09Z",
+  "expires_at": "2020-05-05T09:51:17Z",
   "forced": true,
   "id": "string",
-  "issued_at": "2020-04-30T11:21:09Z",
+  "issued_at": "2020-05-05T09:51:17Z",
   "methods": {
     "property1": {
       "config": {
@@ -5586,9 +5586,9 @@ _Error response_
 ```json
 {
   "active": "string",
-  "expires_at": "2020-04-30T11:21:09Z",
+  "expires_at": "2020-05-05T09:51:17Z",
   "id": "string",
-  "issued_at": "2020-04-30T11:21:09Z",
+  "issued_at": "2020-05-05T09:51:17Z",
   "methods": {
     "property1": {
       "config": {
@@ -5815,16 +5815,16 @@ _Error response_
 
 ```json
 {
-  "authenticated_at": "2020-04-30T11:21:09Z",
-  "expires_at": "2020-04-30T11:21:09Z",
+  "authenticated_at": "2020-05-05T09:51:17Z",
+  "expires_at": "2020-05-05T09:51:17Z",
   "identity": {
     "addresses": [
       {
-        "expires_at": "2020-04-30T11:21:09Z",
+        "expires_at": "2020-05-05T09:51:17Z",
         "id": "string",
         "value": "string",
         "verified": true,
-        "verified_at": "2020-04-30T11:21:09Z",
+        "verified_at": "2020-05-05T09:51:17Z",
         "via": "string"
       }
     ],
@@ -5833,7 +5833,7 @@ _Error response_
     "traits_schema_id": "string",
     "traits_schema_url": "string"
   },
-  "issued_at": "2020-04-30T11:21:09Z",
+  "issued_at": "2020-05-05T09:51:17Z",
   "sid": "string"
 }
 ```
@@ -5857,16 +5857,16 @@ _Error response_
 ```json
 {
   "active": "string",
-  "expires_at": "2020-04-30T11:21:09Z",
+  "expires_at": "2020-05-05T09:51:17Z",
   "id": "string",
   "identity": {
     "addresses": [
       {
-        "expires_at": "2020-04-30T11:21:09Z",
+        "expires_at": "2020-05-05T09:51:17Z",
         "id": "string",
         "value": "string",
         "verified": true,
-        "verified_at": "2020-04-30T11:21:09Z",
+        "verified_at": "2020-05-05T09:51:17Z",
         "via": "string"
       }
     ],
@@ -5875,7 +5875,7 @@ _Error response_
     "traits_schema_id": "string",
     "traits_schema_url": "string"
   },
-  "issued_at": "2020-04-30T11:21:09Z",
+  "issued_at": "2020-05-05T09:51:17Z",
   "methods": {
     "property1": {
       "config": {
@@ -6004,7 +6004,7 @@ _Request presents a settings request_
 
 ```json
 {
-  "expires_at": "2020-04-30T11:21:09Z",
+  "expires_at": "2020-05-05T09:51:17Z",
   "form": {
     "action": "string",
     "errors": [
@@ -6030,7 +6030,7 @@ _Request presents a settings request_
     "method": "string"
   },
   "id": "string",
-  "issued_at": "2020-04-30T11:21:09Z",
+  "issued_at": "2020-05-05T09:51:17Z",
   "request_url": "string",
   "success": true,
   "via": "string"