autogen(docs): generate and format documentation

ory · Mar 24, 2021 · 9ad9c1d · 9ad9c1d
1 parent be012b6
commit 9ad9c1d
Show file tree

Hide file tree

Showing 11 changed files with 50 additions and 40 deletions.
diff --git a/docs/docs/configure-deploy.mdx b/docs/docs/configure-deploy.mdx
@@ -76,11 +76,11 @@ $ export SECRETS_SYSTEM=$(export LC_CTYPE=C; cat /dev/urandom | tr -dc 'a-zA-Z0-
 $ export DSN=postgres://hydra:secret@ory-hydra-example--postgres:5432/hydra?sslmode=disable
 
 # Before starting, let's pull the latest ORY Hydra tag from docker.
-$ docker pull oryd/hydra:v1.9.3-pre.4
+$ docker pull oryd/hydra:v1.9.3-pre.5
 
 # This command will show you all the environment variables that you can set. Read this carefully.
 # It is the equivalent to `hydra help serve`.
-$ docker run -it --rm --entrypoint hydra oryd/hydra:v1.9.3-pre.4 help serve
+$ docker run -it --rm --entrypoint hydra oryd/hydra:v1.9.3-pre.5 help serve
 
 Starts all HTTP/2 APIs and connects to a database backend.
 [...]
@@ -90,7 +90,7 @@ Starts all HTTP/2 APIs and connects to a database backend.
 # It is the equivalent to `hydra migrate sql --yes postgres://hydra:secret@ory-hydra-example--postgres:5432/hydra?sslmode=disable`
 $ docker run -it --rm \
  --network hydraguide \
- oryd/hydra:v1.9.3-pre.4 \
+ oryd/hydra:v1.9.3-pre.5 \
  migrate sql --yes $DSN
 
 Applying `client` SQL migrations...
@@ -108,7 +108,7 @@ $ docker run -d \
  -e URLS_SELF_ISSUER=https://localhost:9000/ \
  -e URLS_CONSENT=http://localhost:9020/consent \
  -e URLS_LOGIN=http://localhost:9020/login \
- oryd/hydra:v1.9.3-pre.4 serve all
+ oryd/hydra:v1.9.3-pre.5 serve all
 
 # And check if it's running:
 $ docker logs ory-hydra-example--hydra
@@ -159,7 +159,7 @@ mount it in the container. For example:
 ```shell
 $ docker run -d \
  -v $(pwd)/hydra.yaml:/hydra.yaml \
- oryd/hydra:v1.9.3-pre.4 serve all --config /hydra.yaml
+ oryd/hydra:v1.9.3-pre.5 serve all --config /hydra.yaml
 ```
 
 :::
@@ -194,7 +194,7 @@ ORY Hydra can be managed using the Hydra Command Line Interface (CLI), which is
 using ORY Hydra's REST APIs. To see the available commands, run:
 
 ```shell
-$ docker run --rm -it --entrypoint hydra oryd/hydra:v1.9.3-pre.4 help
+$ docker run --rm -it --entrypoint hydra oryd/hydra:v1.9.3-pre.5 help
 Hydra is a cloud native high throughput OAuth2 and OpenID Connect provider
 
 Usage:
@@ -253,7 +253,7 @@ URLs the client may request:
 $ docker run --rm -it \
  -e HYDRA_ADMIN_URL=https://ory-hydra-example--hydra:4445 \
  --network hydraguide \
- oryd/hydra:v1.9.3-pre.4 \
+ oryd/hydra:v1.9.3-pre.5 \
  clients create --skip-tls-verify \
  --id facebook-photo-backup \
  --secret some-secret \
@@ -300,7 +300,7 @@ for an access token. The same thing happens with this command:
 $ docker run --rm -it \
  --network hydraguide \
  -p 9010:9010 \
- oryd/hydra:v1.9.3-pre.4 \
+ oryd/hydra:v1.9.3-pre.5 \
  token user --skip-tls-verify \
  --port 9010 \
  --auth-url https://localhost:9000/oauth2/auth \

diff --git a/docs/docs/install.md b/docs/docs/install.md
@@ -11,8 +11,8 @@ binaries, Docker Images and support various package managers.
 We recommend using Docker to run ORY Hydra:
 
 ```shell
-$ docker pull oryd/hydra:v1.9.3-pre.4
-$ docker run --rm -it oryd/hydra:v1.9.3-pre.4 help
+$ docker pull oryd/hydra:v1.9.3-pre.5
+$ docker run --rm -it oryd/hydra:v1.9.3-pre.5 help
 ```
 
 ## macOS

diff --git a/docs/docs/reference/api.mdx b/docs/docs/reference/api.mdx
@@ -8005,6 +8005,7 @@ _NullTime implements sql.NullTime functionality._
  }
  ],
  "Interface": {
+ "ProtocolScheme": "string",
  "Socket": "string",
  "Types": [
  {
@@ -8112,6 +8113,7 @@ _PluginConfigArgs plugin config args_
 
 ```json
 {
+ "ProtocolScheme": "string",
  "Socket": "string",
  "Types": [
  {
@@ -8127,10 +8129,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>
 
@@ -8528,7 +8531,7 @@ _Volume volume_
 | Name | string | true | none | Name of the volume. |
 | Options | object | true | none | The driver specific options used when creating the volume. |
 | » **additionalProperties** | string | false | none | none |
-| Scope | string | true | none | The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level.  |
+| Scope | string | true | none | The level at which the volume exists. Either `global` for cluster-wide,<br/>or `local` for machine level. |
 | Status | object | false | none | Low-level details about the volume, provided by the volume driver.<br/>Details are returned as a map with key/value pairs:<br/>`{"key":"value","key2":"value2"}`.<br/><br/>The `Status` field is optional, and is omitted if the volume driver<br/>does not support this feature. |
 | UsageData | [VolumeUsageData](#schemavolumeusagedata) | false | none | VolumeUsageData Usage details about the volume. This information is used by the<br/>`GET /system/df` endpoint, and omitted in other endpoints. |
 

diff --git a/docs/versioned_docs/version-v1.9/configure-deploy.mdx b/docs/versioned_docs/version-v1.9/configure-deploy.mdx
@@ -76,11 +76,11 @@ $ export SECRETS_SYSTEM=$(export LC_CTYPE=C; cat /dev/urandom | tr -dc 'a-zA-Z0-
 $ export DSN=postgres://hydra:secret@ory-hydra-example--postgres:5432/hydra?sslmode=disable
 
 # Before starting, let's pull the latest ORY Hydra tag from docker.
-$ docker pull oryd/hydra:v1.9.3-pre.4
+$ docker pull oryd/hydra:v1.9.3-pre.5
 
 # This command will show you all the environment variables that you can set. Read this carefully.
 # It is the equivalent to `hydra help serve`.
-$ docker run -it --rm --entrypoint hydra oryd/hydra:v1.9.3-pre.4 help serve
+$ docker run -it --rm --entrypoint hydra oryd/hydra:v1.9.3-pre.5 help serve
 
 Starts all HTTP/2 APIs and connects to a database backend.
 [...]
@@ -90,7 +90,7 @@ Starts all HTTP/2 APIs and connects to a database backend.
 # It is the equivalent to `hydra migrate sql --yes postgres://hydra:secret@ory-hydra-example--postgres:5432/hydra?sslmode=disable`
 $ docker run -it --rm \
  --network hydraguide \
- oryd/hydra:v1.9.3-pre.4 \
+ oryd/hydra:v1.9.3-pre.5 \
  migrate sql --yes $DSN
 
 Applying `client` SQL migrations...
@@ -108,7 +108,7 @@ $ docker run -d \
  -e URLS_SELF_ISSUER=https://localhost:9000/ \
  -e URLS_CONSENT=http://localhost:9020/consent \
  -e URLS_LOGIN=http://localhost:9020/login \
- oryd/hydra:v1.9.3-pre.4 serve all
+ oryd/hydra:v1.9.3-pre.5 serve all
 
 # And check if it's running:
 $ docker logs ory-hydra-example--hydra
@@ -159,7 +159,7 @@ mount it in the container. For example:
 ```shell
 $ docker run -d \
  -v $(pwd)/hydra.yaml:/hydra.yaml \
- oryd/hydra:v1.9.3-pre.4 serve all --config /hydra.yaml
+ oryd/hydra:v1.9.3-pre.5 serve all --config /hydra.yaml
 ```
 
 :::
@@ -194,7 +194,7 @@ ORY Hydra can be managed using the Hydra Command Line Interface (CLI), which is
 using ORY Hydra's REST APIs. To see the available commands, run:
 
 ```shell
-$ docker run --rm -it --entrypoint hydra oryd/hydra:v1.9.3-pre.4 help
+$ docker run --rm -it --entrypoint hydra oryd/hydra:v1.9.3-pre.5 help
 Hydra is a cloud native high throughput OAuth2 and OpenID Connect provider
 
 Usage:
@@ -253,7 +253,7 @@ URLs the client may request:
 $ docker run --rm -it \
  -e HYDRA_ADMIN_URL=https://ory-hydra-example--hydra:4445 \
  --network hydraguide \
- oryd/hydra:v1.9.3-pre.4 \
+ oryd/hydra:v1.9.3-pre.5 \
  clients create --skip-tls-verify \
  --id facebook-photo-backup \
  --secret some-secret \
@@ -300,7 +300,7 @@ for an access token. The same thing happens with this command:
 $ docker run --rm -it \
  --network hydraguide \
  -p 9010:9010 \
- oryd/hydra:v1.9.3-pre.4 \
+ oryd/hydra:v1.9.3-pre.5 \
  token user --skip-tls-verify \
  --port 9010 \
  --auth-url https://localhost:9000/oauth2/auth \

diff --git a/docs/versioned_docs/version-v1.9/install.md b/docs/versioned_docs/version-v1.9/install.md
@@ -11,8 +11,8 @@ binaries, Docker Images and support various package managers.
 We recommend using Docker to run ORY Hydra:
 
 ```shell
-$ docker pull oryd/hydra:v1.9.3-pre.4
-$ docker run --rm -it oryd/hydra:v1.9.3-pre.4 help
+$ docker pull oryd/hydra:v1.9.3-pre.5
+$ docker run --rm -it oryd/hydra:v1.9.3-pre.5 help
 ```
 
 ## macOS

diff --git a/docs/versioned_docs/version-v1.9/reference/api.mdx b/docs/versioned_docs/version-v1.9/reference/api.mdx
@@ -8005,6 +8005,7 @@ _NullTime implements sql.NullTime functionality._
  }
  ],
  "Interface": {
+ "ProtocolScheme": "string",
  "Socket": "string",
  "Types": [
  {
@@ -8112,6 +8113,7 @@ _PluginConfigArgs plugin config args_
 
 ```json
 {
+ "ProtocolScheme": "string",
  "Socket": "string",
  "Types": [
  {
@@ -8127,10 +8129,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>
 
@@ -8528,7 +8531,7 @@ _Volume volume_
 | Name | string | true | none | Name of the volume. |
 | Options | object | true | none | The driver specific options used when creating the volume. |
 | » **additionalProperties** | string | false | none | none |
-| Scope | string | true | none | The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level.  |
+| Scope | string | true | none | The level at which the volume exists. Either `global` for cluster-wide,<br/>or `local` for machine level. |
 | Status | object | false | none | Low-level details about the volume, provided by the volume driver.<br/>Details are returned as a map with key/value pairs:<br/>`{"key":"value","key2":"value2"}`.<br/><br/>The `Status` field is optional, and is omitted if the volume driver<br/>does not support this feature. |
 | UsageData | [VolumeUsageData](#schemavolumeusagedata) | false | none | VolumeUsageData Usage details about the volume. This information is used by the<br/>`GET /system/df` endpoint, and omitted in other endpoints. |
 

diff --git a/quickstart-cockroach.yml b/quickstart-cockroach.yml
@@ -14,12 +14,12 @@ version: '3.7'
 
 services:
  hydra-migrate:
- image: oryd/hydra:v1.9.3-pre.4
+ image: oryd/hydra:v1.9.3-pre.5
  environment:
  - DSN=cockroach://root@cockroachd:26257/defaultdb?sslmode=disable&max_conns=20&max_idle_conns=4
 
  hydra:
- image: oryd/hydra:v1.9.3-pre.4
+ image: oryd/hydra:v1.9.3-pre.5
  environment:
  - DSN=cockroach://root@cockroachd:26257/defaultdb?sslmode=disable&max_conns=20&max_idle_conns=4
 

diff --git a/quickstart-mysql.yml b/quickstart-mysql.yml
@@ -15,12 +15,12 @@ version: '3.7'
 services:
 
  hydra-migrate:
- image: oryd/hydra:v1.9.3-pre.4
+ image: oryd/hydra:v1.9.3-pre.5
  environment:
  - DSN=mysql://root:secret@tcp(mysqld:3306)/mysql?max_conns=20&max_idle_conns=4
 
  hydra:
- image: oryd/hydra:v1.9.3-pre.4
+ image: oryd/hydra:v1.9.3-pre.5
  environment:
  - DSN=mysql://root:secret@tcp(mysqld:3306)/mysql?max_conns=20&max_idle_conns=4
 

diff --git a/quickstart-postgres.yml b/quickstart-postgres.yml
@@ -15,12 +15,12 @@ version: '3.7'
 services:
 
  hydra-migrate:
- image: oryd/hydra:v1.9.3-pre.4
+ image: oryd/hydra:v1.9.3-pre.5
  environment:
  - DSN=postgres://hydra:secret@postgresd:5432/hydra?sslmode=disable&max_conns=20&max_idle_conns=4
 
  hydra:
- image: oryd/hydra:v1.9.3-pre.4
+ image: oryd/hydra:v1.9.3-pre.5
  environment:
  - DSN=postgres://hydra:secret@postgresd:5432/hydra?sslmode=disable&max_conns=20&max_idle_conns=4
 

diff --git a/quickstart.yml b/quickstart.yml
@@ -15,7 +15,7 @@ version: '3.7'
 services:
 
  hydra:
- image: oryd/hydra:v1.9.3-pre.4-sqlite
+ image: oryd/hydra:v1.9.3-pre.5-sqlite
  ports:
  - "4444:4444" # Public port
  - "4445:4445" # Admin port
@@ -41,7 +41,7 @@ services:
  - intranet
 
  hydra-migrate:
- image: oryd/hydra:v1.9.3-pre.4-sqlite
+ image: oryd/hydra:v1.9.3-pre.5-sqlite
  environment:
  - DSN=sqlite:///var/lib/sqlite/db.sqlite?_fk=true
  command:
@@ -63,7 +63,7 @@ services:
  consent:
  environment:
  - HYDRA_ADMIN_URL=http://hydra:4445
- image: oryd/hydra-login-consent-node:v1.9.3-pre.4
+ image: oryd/hydra-login-consent-node:v1.9.3-pre.5
  ports:
  - "3000:3000"
  restart: unless-stopped

diff --git a/spec/api.json b/spec/api.json
@@ -2105,6 +2105,10 @@
  "Types"
  ],
  "properties": {
+ "ProtocolScheme": {
+ "description": "Protocol to use for clients connecting to the plugin.",
+ "type": "string"
+ },
  "Socket": {
  "description": "socket",
  "type": "string"
@@ -2447,7 +2451,7 @@
  }
  },
  "Scope": {
- "description": "The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level.",
+ "description": "The level at which the volume exists. Either `global` for cluster-wide,\nor `local` for machine level.",
  "type": "string"
  },
  "Status": {