Skip to content

Commit

Permalink
fix: config schema rendering automation
Browse files Browse the repository at this point in the history
Re-rendered the up-to-date schema once manually. Should be automatically re-rendered on release now.
  • Loading branch information
alnr committed Sep 9, 2024
1 parent 6fd2968 commit bc9426e
Show file tree
Hide file tree
Showing 6 changed files with 38 additions and 1,528 deletions.
5 changes: 5 additions & 0 deletions .orycli.yml
Original file line number Diff line number Diff line change
@@ -1 +1,6 @@
project: oathkeeper

pre_release_hooks:
- ./scripts/render-schemas.sh
- git config --unset user.email
- git config --unset user.name
1 change: 1 addition & 0 deletions .schema/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Do not edit files in this directory. They are generated by CI using render-schemas.sh and other automation. Edit spec/config.schema.json instead.
32 changes: 30 additions & 2 deletions .schema/config.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -483,6 +483,11 @@
}
]
},
"prefix": {
"title": "Token Prefix",
"type": "string",
"description": "The token is considered only if it starts with this string."
},
"preserve_query": {
"title": "Preserve Query",
"type": "boolean",
Expand Down Expand Up @@ -822,6 +827,17 @@
"type": "string"
}
},
"prefix": {
"title": "Token Prefix",
"type": "string",
"description": "The token is considered only if it starts with this string."
},
"preserve_host": {
"title": "Preserve Host",
"type": "boolean",
"description": "When set to true the HTTP Header X-Forwarded-Host will be set to the original HTTP host.",
"default": false
},
"introspection_request_headers": {
"title": "Introspection Request Headers",
"description": "Additional headers to be added to the introspection request.",
Expand Down Expand Up @@ -974,6 +990,12 @@
"description": "The URL of the remote authorizer. The remote authorizer is expected to return either 200 OK or 403 Forbidden to allow/deny access.\n\n>If this authorizer is enabled, this value is required.",
"examples": ["https://host/path"]
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"payload": {
"title": "JSON Payload",
"type": "string",
Expand Down Expand Up @@ -1176,6 +1198,12 @@
"title": "Host",
"description": "The network interface to listen on. Leave empty to listen on all interfaces."
},
"trust_forwarded_headers": {
"type": "boolean",
"default": false,
"title": "Trust X-Forwarded Headers",
"description": "Trust the X-Forwarded-* headers from the reverse proxy. This is useful when running behind a load balancer or similar. Set this to false if you are not running behind a reverse proxy that prevents Hop-by-Hop attacks."
},
"timeout": {
"$ref": "#/definitions/serverTimeout"
},
Expand Down Expand Up @@ -1843,10 +1871,10 @@
}
},
"log": {
"$ref": "https://raw.githubusercontent.com/ory/x/v0.0.532/logrusx/config.schema.json"
"$ref": "https://raw.githubusercontent.com/ory/x/v0.0.605/logrusx/config.schema.json"
},
"tracing": {
"$ref": "https://raw.githubusercontent.com/ory/x/v0.0.532/tracing/config.schema.json"
"$ref": "https://raw.githubusercontent.com/ory/x/v0.0.605/otelx/config.schema.json"
},
"profiling": {
"title": "Profiling",
Expand Down
Loading

0 comments on commit bc9426e

Please sign in to comment.