Skip to content

Commit

Permalink
refactor: move docs to this repository (#396)
Browse files Browse the repository at this point in the history
  • Loading branch information
aeneasr authored Apr 6, 2020
1 parent 7121f65 commit 11cb851
Show file tree
Hide file tree
Showing 150 changed files with 28,578 additions and 799 deletions.
68 changes: 20 additions & 48 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -1,35 +1,14 @@
version: 2.1

orbs:
sdk: ory/[email protected]
changelog: ory/[email protected]
goreleaser: ory/[email protected]
nancy: ory/[email protected]
sdk: ory/[email protected]
changelog: ory/[email protected]
goreleaser: ory/[email protected]
nancy: ory/[email protected]
docs: ory/[email protected]
golangci: ory/[email protected]

jobs:
format:
docker:
- image: circleci/golang:1.13
working_directory: /go/src/github.com/ory/oathkeeper
steps:
# This is disabled for now because goimports is really slow when go modules are used, see
# https://github.com/golang/go/issues/27287
#
# - run:
# name: Enable go1.12 modules
# command: |
# echo 'export GO111MODULE=on' >> $BASH_ENV
# source $BASH_ENV
- checkout
- run:
name: Enable go1.13 modules
command: |
echo 'export GO111MODULE=on' >> $BASH_ENV
source $BASH_ENV
- run: curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh -s -- -b $(go env GOPATH)/bin latest
- run: go mod download
- run: golangci-lint run ./...

test:
docker:
- image: circleci/golang:1.14
Expand All @@ -46,41 +25,25 @@ jobs:
- run: ./test/e2e/run.sh
- run: ./test/reload/run.sh

docs:
docker:
- image: circleci/golang:1.13
working_directory: /go/src/github.com/ory/oathkeeper
steps:
- checkout
- run: git config --global user.email "[email protected]"
- run: git config --global user.name "ORY Continuous Integration"
- run: "git clone https://arekkas:[email protected]/ory/docs.git ../docs"
- run: "cp ./.schemas/config.schema.json ../docs/schemas/oathkeeper.config.schema.json"
- run: "(cd ../docs && git add -A && git commit -a -m \"Update ORY Oathkeeper Swagger and JSON Schemas\" && git push origin) || exit 0"

workflows:
"test, build, and relase":
jobs:
- nancy/test:
filters:
tags:
only: /.*/
- format:
- golangci/lint:
filters:
tags:
only: /.*/
- test:
filters:
tags:
only: /.*/
- docs:
filters:
branches:
only: master
- changelog/generate:
requires:
- test
- format
- golangci/lint
filters:
tags:
only: /.*/
Expand All @@ -90,11 +53,11 @@ workflows:
appname: Ory_Oathkeeper
requires:
- test
- format
- golangci/lint
- sdk/release:
requires:
- test
- format
- golangci/lint
- goreleaser/release
filters:
tags:
Expand All @@ -109,9 +72,18 @@ workflows:
requires:
- goreleaser/test
- test
- format
- golangci/lint
filters:
tags:
only: /.*/
branches:
ignore: /.*/
- docs/build:
requires:
- test
- golangci/lint
filters:
tags:
only: /.*/
branches:
only: master
File renamed without changes
File renamed without changes.
42 changes: 21 additions & 21 deletions .schemas/config.schema.json → .schema/config.schema.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/ory/oathkeeper/v0.34.0-beta.1/.schemas/config.schema.json",
"$id": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/config.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "ORY Oathkeeper Configuration",
"type": "object",
Expand Down Expand Up @@ -314,7 +314,7 @@
"realm": {
"type": "string",
"title": "The WWW-Authenticate Realm",
"description": "This is a message that will be displayed by the browser. Most browsers show a message like \"The website says: <realm>\". Using a real message is thus more appropriate than a Realm identifier.",
"description": "This is a message that will be displayed by the browser. Most browsers show a message like \"The website says: `,<realm>`\". Using a real message is thus more appropriate than a Realm identifier.",
"default": "Please authenticate."
},
"when": {
Expand Down Expand Up @@ -1044,12 +1044,12 @@
"authenticators": {
"title": "Authenticators",
"type": "object",
"description": "For more information on authenticators head over to: https://www.ory.sh/docs/oathkeeper/pipeline/authn",
"description": "For more information on authenticators head over to: https://www.ory.sh/oathkeeper/docs/pipeline/authn",
"additionalProperties": false,
"properties": {
"anonymous": {
"title": "Anonymous",
"description": "The [`anonymous` authenticator](https://www.ory.sh/docs/oathkeeper/pipeline/authn#anonymous).",
"description": "The [`anonymous` authenticator](https://www.ory.sh/oathkeeper/docs/pipeline/authn#anonymous).",
"type": "object",
"additionalProperties": false,
"properties": {
Expand All @@ -1063,7 +1063,7 @@
},
"noop": {
"title": "No Operation (noop)",
"description": "The [`noop` authenticator](https://www.ory.sh/docs/oathkeeper/pipeline/authn#noop).",
"description": "The [`noop` authenticator](https://www.ory.sh/oathkeeper/docs/pipeline/authn#noop).",
"type": "object",
"additionalProperties": false,
"properties": {
Expand All @@ -1074,7 +1074,7 @@
},
"unauthorized": {
"title": "Unauthorized",
"description": "The [`unauthorized` authenticator](https://www.ory.sh/docs/oathkeeper/pipeline/authn#unauthorized).",
"description": "The [`unauthorized` authenticator](https://www.ory.sh/oathkeeper/docs/pipeline/authn#unauthorized).",
"type": "object",
"additionalProperties": false,
"properties": {
Expand All @@ -1085,7 +1085,7 @@
},
"cookie_session": {
"title": "Cookie Session",
"description": "The [`cookie_session` authenticator](https://www.ory.sh/docs/oathkeeper/pipeline/authn#cookie_session).",
"description": "The [`cookie_session` authenticator](https://www.ory.sh/oathkeeper/docs/pipeline/authn#cookie_session).",
"type": "object",
"properties": {
"enabled": {
Expand Down Expand Up @@ -1117,7 +1117,7 @@
},
"jwt": {
"title": "JSON Web Token (jwt)",
"description": "The [`jwt` authenticator](https://www.ory.sh/docs/oathkeeper/pipeline/authn#jwt).",
"description": "The [`jwt` authenticator](https://www.ory.sh/oathkeeper/docs/pipeline/authn#jwt).",
"type": "object",
"properties": {
"enabled": {
Expand Down Expand Up @@ -1149,7 +1149,7 @@
},
"oauth2_client_credentials": {
"title": "OAuth 2.0 Client Credentials",
"description": "The [`oauth2_client_credentials` authenticator](https://www.ory.sh/docs/oathkeeper/pipeline/authn#oauth2_client_credentials).",
"description": "The [`oauth2_client_credentials` authenticator](https://www.ory.sh/oathkeeper/docs/pipeline/authn#oauth2_client_credentials).",
"type": "object",
"properties": {
"enabled": {
Expand Down Expand Up @@ -1181,7 +1181,7 @@
},
"oauth2_introspection": {
"title": "OAuth 2.0 Token Introspection",
"description": "The [`oauth2_introspection` authenticator](https://www.ory.sh/docs/oathkeeper/pipeline/authn#oauth2_introspection).",
"description": "The [`oauth2_introspection` authenticator](https://www.ory.sh/oathkeeper/docs/pipeline/authn#oauth2_introspection).",
"type": "object",
"properties": {
"enabled": {
Expand Down Expand Up @@ -1345,12 +1345,12 @@
"authorizers": {
"title": "Authorizers",
"type": "object",
"description": "For more information on authorizers head over to: https://www.ory.sh/docs/oathkeeper/pipeline/authz",
"description": "For more information on authorizers head over to: https://www.ory.sh/oathkeeper/docs/pipeline/authz",
"additionalProperties": false,
"properties": {
"allow": {
"title": "Allow",
"description": "The [`allow` authorizer](https://www.ory.sh/docs/oathkeeper/pipeline/authz#allow).",
"description": "The [`allow` authorizer](https://www.ory.sh/oathkeeper/docs/pipeline/authz#allow).",
"type": "object",
"additionalProperties": false,
"properties": {
Expand All @@ -1361,7 +1361,7 @@
},
"deny": {
"title": "Deny",
"description": "The [`deny` authorizer](https://www.ory.sh/docs/oathkeeper/pipeline/authz#allow).",
"description": "The [`deny` authorizer](https://www.ory.sh/oathkeeper/docs/pipeline/authz#allow).",
"type": "object",
"additionalProperties": false,
"properties": {
Expand All @@ -1372,7 +1372,7 @@
},
"keto_engine_acp_ory": {
"title": "ORY Keto Access Control Policies Engine",
"description": "The [`keto_engine_acp_ory` authorizer](https://www.ory.sh/docs/oathkeeper/pipeline/authz#keto_engine_acp_ory).",
"description": "The [`keto_engine_acp_ory` authorizer](https://www.ory.sh/oathkeeper/docs/pipeline/authz#keto_engine_acp_ory).",
"type": "object",
"properties": {
"enabled": {
Expand Down Expand Up @@ -1404,7 +1404,7 @@
},
"remote_json": {
"title": "Remote JSON",
"description": "The [`remote_json` authorizer](https://www.ory.sh/docs/oathkeeper/pipeline/authz#remote_json).",
"description": "The [`remote_json` authorizer](https://www.ory.sh/oathkeeper/docs/pipeline/authz#remote_json).",
"type": "object",
"properties": {
"enabled": {
Expand Down Expand Up @@ -1439,12 +1439,12 @@
"mutators": {
"title": "Mutators",
"type": "object",
"description": "For more information on mutators head over to: https://www.ory.sh/docs/oathkeeper/pipeline/mutator",
"description": "For more information on mutators head over to: https://www.ory.sh/oathkeeper/docs/pipeline/mutator",
"additionalProperties": false,
"properties": {
"noop": {
"title": "No Operation (noop)",
"description": "The [`noop` mutator](https://www.ory.sh/docs/oathkeeper/pipeline/mutator#noop).",
"description": "The [`noop` mutator](https://www.ory.sh/oathkeeper/docs/pipeline/mutator#noop).",
"type": "object",
"additionalProperties": false,
"properties": {
Expand All @@ -1455,7 +1455,7 @@
},
"cookie": {
"title": "HTTP Cookie",
"description": "The [`cookie` mutator](https://www.ory.sh/docs/oathkeeper/pipeline/mutator#cookie).",
"description": "The [`cookie` mutator](https://www.ory.sh/oathkeeper/docs/pipeline/mutator#cookie).",
"type": "object",
"properties": {
"enabled": {
Expand Down Expand Up @@ -1487,7 +1487,7 @@
},
"header": {
"title": "HTTP Header",
"description": "The [`header` mutator](https://www.ory.sh/docs/oathkeeper/pipeline/mutator#header).",
"description": "The [`header` mutator](https://www.ory.sh/oathkeeper/docs/pipeline/mutator#header).",
"type": "object",
"properties": {
"enabled": {
Expand Down Expand Up @@ -1519,7 +1519,7 @@
},
"hydrator": {
"title": "Hydrator",
"description": "The [`hydrator` mutator](https://www.ory.sh/docs/oathkeeper/pipeline/mutator#hydrator).",
"description": "The [`hydrator` mutator](https://www.ory.sh/oathkeeper/docs/pipeline/mutator#hydrator).",
"type": "object",
"properties": {
"enabled": {
Expand Down Expand Up @@ -1551,7 +1551,7 @@
},
"id_token": {
"title": "ID Token (JSON Web Token)",
"description": "The [`id_token` mutator](https://www.ory.sh/docs/oathkeeper/pipeline/mutator#id_token).",
"description": "The [`id_token` mutator](https://www.ory.sh/oathkeeper/docs/pipeline/mutator#id_token).",
"type": "object",
"properties": {
"enabled": {
Expand Down
5 changes: 5 additions & 0 deletions .schema/pipeline/authenticators.anonymous.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/authenticators.anonymous.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"$ref": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/config.schema.json#/definitions/configAuthenticatorsAnonymous"
}
5 changes: 5 additions & 0 deletions .schema/pipeline/authenticators.cookie_session.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/authenticators.cookie_session.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"$ref": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/config.schema.json#/definitions/configAuthenticatorsCookieSession"
}
5 changes: 5 additions & 0 deletions .schema/pipeline/authenticators.jwt.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/authenticators.jwt.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"$ref": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/config.schema.json#/definitions/configAuthenticatorsJwt"
}
5 changes: 5 additions & 0 deletions .schema/pipeline/authenticators.noop.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/authenticators.noop.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"$ref": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/config.schema.json#/definitions/configAuthenticatorsAnonymous"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/authenticators.oauth2_client_credentials.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"$ref": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/config.schema.json#/definitions/configAuthenticatorsOauth2ClientCredentials"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/authenticators.oauth2_introspection.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"$ref": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/config.schema.json#/definitions/configAuthenticatorsOauth2Introspection"
}
5 changes: 5 additions & 0 deletions .schema/pipeline/authenticators.unauthorized.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/authenticators.unauthorized.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"$ref": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/config.schema.json#/definitions/configAuthenticatorsAnonymous"
}
4 changes: 4 additions & 0 deletions .schema/pipeline/authorizers.allow.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"$id": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/authorizers.allow.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#"
}
4 changes: 4 additions & 0 deletions .schema/pipeline/authorizers.deny.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"$id": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/authorizers.deny.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#"
}
5 changes: 5 additions & 0 deletions .schema/pipeline/authorizers.keto_engine_acp_ory.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/authorizers.keto_engine_acp_ory.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"$ref": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/config.schema.json#/definitions/configAuthorizersKetoEngineAcpOry"
}
5 changes: 5 additions & 0 deletions .schema/pipeline/authorizers.remote_json.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/authorizers.remote_json.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"$ref": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/config.schema.json#/definitions/configAuthorizersRemoteJSON"
}
5 changes: 5 additions & 0 deletions .schema/pipeline/errors.json.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/mutators.cookie.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"$ref": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/config.schema.json#/definitions/configErrorsJSON"
}
5 changes: 5 additions & 0 deletions .schema/pipeline/errors.redirect.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/mutators.cookie.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"$ref": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/config.schema.json#/definitions/configErrorsRedirect"
}
5 changes: 5 additions & 0 deletions .schema/pipeline/errors.www_authenticate.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/mutators.cookie.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"$ref": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/config.schema.json#/definitions/configErrorsWWWAuthenticate"
}
5 changes: 5 additions & 0 deletions .schema/pipeline/mutators.cookie.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/mutators.cookie.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"$ref": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/config.schema.json#/definitions/configMutatorsCookie"
}
5 changes: 5 additions & 0 deletions .schema/pipeline/mutators.header.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/mutators.header.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"$ref": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/config.schema.json#/definitions/configMutatorsHeader"
}
5 changes: 5 additions & 0 deletions .schema/pipeline/mutators.hydrator.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$id": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/mutators.hydrator.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"$ref": "https://raw.githubusercontent.com/ory/oathkeeper/master/.schema/config.schema.json#/definitions/configMutatorsHydrator"
}
Loading

0 comments on commit 11cb851

Please sign in to comment.