From f329818ad1d7f4a1fda8402a863cb2d4628105bc Mon Sep 17 00:00:00 2001 From: aeneasr Date: Fri, 23 Jul 2021 09:43:23 +0000 Subject: [PATCH 1/2] chore: update docusaurus template Signed-off-by: aeneasr --- docs/package-lock.json | 96 +++++++++++++++++++++++++++++++++--------- docs/scripts/config.js | 4 ++ 2 files changed, 81 insertions(+), 19 deletions(-) diff --git a/docs/package-lock.json b/docs/package-lock.json index 2d10a942ad..e848af1a63 100644 --- a/docs/package-lock.json +++ b/docs/package-lock.json @@ -15,6 +15,7 @@ "@docusaurus/theme-classic": "2.0.0-beta.3", "@docusaurus/theme-search-algolia": "2.0.0-beta.3", "classnames": "2.3.1", + "docusaurus-theme-redoc": "^0.4.4", "file-loader": "6.2.0", "mermaid": "8.11.0", "node-fetch": "2.6.1", @@ -2999,6 +3000,12 @@ "resolved": "https://registry.npmjs.org/@types/parse5/-/parse5-5.0.3.tgz", "integrity": "sha512-kUNnecmtkunAoQ3CnjmMkzNU/gtxG8guhi+Fk2U/kOpIKjIMKnXGp4IJCgQJrXSgMsWYimYG4TGjz/UzbGEBTw==" }, + "node_modules/@types/prop-types": { + "version": "15.7.3", + "resolved": "https://registry.npmjs.org/@types/prop-types/-/prop-types-15.7.3.tgz", + "integrity": "sha512-KfRL3PuHmqQLOG+2tGpRO26Ctg+Cq1E01D2DMriKEATHgWLfeNDmq9e29Q9WIky0dQ3NPkd1mzYH8Lm936Z9qw==", + "peer": true + }, "node_modules/@types/q": { "version": "1.5.4", "resolved": "https://registry.npmjs.org/@types/q/-/q-1.5.4.tgz", @@ -3009,6 +3016,17 @@ "resolved": "https://registry.npmjs.org/@types/qs/-/qs-6.9.6.tgz", "integrity": "sha512-0/HnwIfW4ki2D8L8c9GVcG5I72s9jP5GSLVF0VIXDW00kmIpA6O33G7a8n59Tmh7Nz0WUC3rSb7PTY/sdW2JzA==" }, + "node_modules/@types/react": { + "version": "17.0.13", + "resolved": "https://registry.npmjs.org/@types/react/-/react-17.0.13.tgz", + "integrity": "sha512-D/G3PiuqTfE3IMNjLn/DCp6umjVCSvtZTPdtAFy5+Ved6CsdRvivfKeCzw79W4AatShtU4nGqgvOv5Gro534vQ==", + "peer": true, + "dependencies": { + "@types/prop-types": "*", + "@types/scheduler": "*", + "csstype": "^3.0.2" + } + }, "node_modules/@types/sax": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/@types/sax/-/sax-1.2.1.tgz", @@ -3017,6 +3035,12 @@ "@types/node": "*" } }, + "node_modules/@types/scheduler": { + "version": "0.16.1", + "resolved": "https://registry.npmjs.org/@types/scheduler/-/scheduler-0.16.1.tgz", + "integrity": "sha512-EaCxbanVeyxDRTQBkdLb3Bvl/HK7PBK6UJjsSixB0iHKoWxE5uu2Q/DgtpOhPIojN0Zl1whvOd7PoHs2P0s5eA==", + "peer": true + }, "node_modules/@types/unist": { "version": "2.0.4", "resolved": "https://registry.npmjs.org/@types/unist/-/unist-2.0.4.tgz", @@ -5568,6 +5592,12 @@ "node": ">=0.10.0" } }, + "node_modules/csstype": { + "version": "3.0.8", + "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.0.8.tgz", + "integrity": "sha512-jXKhWqXPmlUeoQnF/EhTtTl4C9SnrxSH/jZUih3jmO6lBKr99rP3/+FmrMj4EFpOXzMtXHAZkd3x0E6h6Fgflw==", + "peer": true + }, "node_modules/d3": { "version": "5.16.0", "resolved": "https://registry.npmjs.org/d3/-/d3-5.16.0.tgz", @@ -9606,6 +9636,17 @@ "url": "https://github.com/chalk/supports-color?sponsor=1" } }, + "node_modules/jgexml": { + "version": "0.4.4", + "resolved": "https://registry.npmjs.org/jgexml/-/jgexml-0.4.4.tgz", + "integrity": "sha512-j0AzSWT7LXy3s3i1cdv5NZxUtscocwiBxgOLiEBfitCehm8STdXVrcOlbAWsJFLCq1elZYpQlGqA9k8Z+n9iJA==", + "dev": true, + "bin": { + "json2xml": "cli/json2xml.js", + "xml2json": "cli/xml2json.js", + "xsd2json": "cli/xsd2json.js" + } + }, "node_modules/joi": { "version": "17.4.0", "resolved": "https://registry.npmjs.org/joi/-/joi-17.4.0.tgz", @@ -9680,7 +9721,6 @@ "version": "0.5.0-rcv.35", "resolved": "https://registry.npmjs.org/json-schema-faker/-/json-schema-faker-0.5.0-rcv.35.tgz", "integrity": "sha512-UsIroMY2VdhO/4Fw2Vv40lnl37YjGp8pjadLJBW5k/eVldKED9xXV++TJUJaCEqnpwg7ixazLUKSm8C81APD4g==", - "deprecated": "broken UMD support, use previous release until RC36", "dev": true, "dependencies": { "json-schema-ref-parser": "^6.1.0", @@ -13180,7 +13220,7 @@ "version": "0.2.0", "resolved": "https://registry.npmjs.org/querystring/-/querystring-0.2.0.tgz", "integrity": "sha1-sgmEkgO7Jd+CDadW50cAWHhSFiA=", - "deprecated": "The querystring API is considered Legacy. new code should use the URLSearchParams API instead.", + "deprecated": "The", "engines": { "node": ">=0.4.x" } @@ -18316,17 +18356,6 @@ "node": ">=4" } }, - "node_modules/widdershins/node_modules/jgexml": { - "version": "0.4.4", - "resolved": "https://registry.npmjs.org/jgexml/-/jgexml-0.4.4.tgz", - "integrity": "sha512-j0AzSWT7LXy3s3i1cdv5NZxUtscocwiBxgOLiEBfitCehm8STdXVrcOlbAWsJFLCq1elZYpQlGqA9k8Z+n9iJA==", - "dev": true, - "bin": { - "json2xml": "cli/json2xml.js", - "xml2json": "cli/xml2json.js", - "xsd2json": "cli/xsd2json.js" - } - }, "node_modules/widdershins/node_modules/json-schema-traverse": { "version": "0.3.1", "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.3.1.tgz", @@ -21000,6 +21029,12 @@ "resolved": "https://registry.npmjs.org/@types/parse5/-/parse5-5.0.3.tgz", "integrity": "sha512-kUNnecmtkunAoQ3CnjmMkzNU/gtxG8guhi+Fk2U/kOpIKjIMKnXGp4IJCgQJrXSgMsWYimYG4TGjz/UzbGEBTw==" }, + "@types/prop-types": { + "version": "15.7.3", + "resolved": "https://registry.npmjs.org/@types/prop-types/-/prop-types-15.7.3.tgz", + "integrity": "sha512-KfRL3PuHmqQLOG+2tGpRO26Ctg+Cq1E01D2DMriKEATHgWLfeNDmq9e29Q9WIky0dQ3NPkd1mzYH8Lm936Z9qw==", + "peer": true + }, "@types/q": { "version": "1.5.4", "resolved": "https://registry.npmjs.org/@types/q/-/q-1.5.4.tgz", @@ -21010,6 +21045,17 @@ "resolved": "https://registry.npmjs.org/@types/qs/-/qs-6.9.6.tgz", "integrity": "sha512-0/HnwIfW4ki2D8L8c9GVcG5I72s9jP5GSLVF0VIXDW00kmIpA6O33G7a8n59Tmh7Nz0WUC3rSb7PTY/sdW2JzA==" }, + "@types/react": { + "version": "17.0.13", + "resolved": "https://registry.npmjs.org/@types/react/-/react-17.0.13.tgz", + "integrity": "sha512-D/G3PiuqTfE3IMNjLn/DCp6umjVCSvtZTPdtAFy5+Ved6CsdRvivfKeCzw79W4AatShtU4nGqgvOv5Gro534vQ==", + "peer": true, + "requires": { + "@types/prop-types": "*", + "@types/scheduler": "*", + "csstype": "^3.0.2" + } + }, "@types/sax": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/@types/sax/-/sax-1.2.1.tgz", @@ -21018,6 +21064,12 @@ "@types/node": "*" } }, + "@types/scheduler": { + "version": "0.16.1", + "resolved": "https://registry.npmjs.org/@types/scheduler/-/scheduler-0.16.1.tgz", + "integrity": "sha512-EaCxbanVeyxDRTQBkdLb3Bvl/HK7PBK6UJjsSixB0iHKoWxE5uu2Q/DgtpOhPIojN0Zl1whvOd7PoHs2P0s5eA==", + "peer": true + }, "@types/unist": { "version": "2.0.4", "resolved": "https://registry.npmjs.org/@types/unist/-/unist-2.0.4.tgz", @@ -23005,6 +23057,12 @@ } } }, + "csstype": { + "version": "3.0.8", + "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.0.8.tgz", + "integrity": "sha512-jXKhWqXPmlUeoQnF/EhTtTl4C9SnrxSH/jZUih3jmO6lBKr99rP3/+FmrMj4EFpOXzMtXHAZkd3x0E6h6Fgflw==", + "peer": true + }, "d3": { "version": "5.16.0", "resolved": "https://registry.npmjs.org/d3/-/d3-5.16.0.tgz", @@ -26140,6 +26198,12 @@ } } }, + "jgexml": { + "version": "0.4.4", + "resolved": "https://registry.npmjs.org/jgexml/-/jgexml-0.4.4.tgz", + "integrity": "sha512-j0AzSWT7LXy3s3i1cdv5NZxUtscocwiBxgOLiEBfitCehm8STdXVrcOlbAWsJFLCq1elZYpQlGqA9k8Z+n9iJA==", + "dev": true + }, "joi": { "version": "17.4.0", "resolved": "https://registry.npmjs.org/joi/-/joi-17.4.0.tgz", @@ -32789,12 +32853,6 @@ "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", "dev": true }, - "jgexml": { - "version": "0.4.4", - "resolved": "https://registry.npmjs.org/jgexml/-/jgexml-0.4.4.tgz", - "integrity": "sha512-j0AzSWT7LXy3s3i1cdv5NZxUtscocwiBxgOLiEBfitCehm8STdXVrcOlbAWsJFLCq1elZYpQlGqA9k8Z+n9iJA==", - "dev": true - }, "json-schema-traverse": { "version": "0.3.1", "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.3.1.tgz", diff --git a/docs/scripts/config.js b/docs/scripts/config.js index 18fe7dc284..71c4e657b8 100644 --- a/docs/scripts/config.js +++ b/docs/scripts/config.js @@ -205,11 +205,15 @@ flag: \`${config.projectSlug} --config path/to/config.yaml\`. Config files can be formatted as JSON, YAML and TOML. Some configuration values support reloading without server restart. All configuration values can be set using environment variables, as documented below. +:::warning Disclaimer + This reference configuration documents all keys, also deprecated ones! It is a reference for all possible configuration values. If you are looking for an example configuration, it is better to try out the quickstart. +::: + To find out more about edge cases like setting string array values through environmental variables head to the [Configuring ORY services](https://www.ory.sh/docs/ecosystem/configuring) section. From a0a13290f42dec8da3de07811715ad8cd4e8a153 Mon Sep 17 00:00:00 2001 From: aeneasr <3372410+aeneasr@users.noreply.github.com> Date: Fri, 23 Jul 2021 15:08:08 +0000 Subject: [PATCH 2/2] autogen(docs): regenerate and update changelog --- CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 735170f2a9..6f81737849 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,7 @@ **Table of Contents** -- [Unreleased (2021-07-19)](#unreleased-2021-07-19) +- [Unreleased (2021-07-23)](#unreleased-2021-07-23) - [Bug Fixes](#bug-fixes) - [Features](#features) - [0.38.14-beta.1 (2021-07-14)](#03814-beta1-2021-07-14) @@ -242,7 +242,7 @@ -# [Unreleased](https://github.com/ory/oathkeeper/compare/v0.38.14-beta.1...1f6c4306c3ec0e860b6606e06133c1f2a796c8e1) (2021-07-19) +# [Unreleased](https://github.com/ory/oathkeeper/compare/v0.38.14-beta.1...1f6c4306c3ec0e860b6606e06133c1f2a796c8e1) (2021-07-23) ### Bug Fixes