Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: updates duplicate/missing references #1211

Merged
merged 1 commit into from
Jan 30, 2024
Merged

Docs: updates duplicate/missing references #1211

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 7 additions & 15 deletions content/docs/reference/reference.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,14 +129,6 @@
"short_description": "Certificate relative file location string",
"services": []
},
"client-certificate-authority": {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be better to remove this entry in a separate PR, if this PR will be backported to the v0.25 docs site. The corresponding change in Core (pomerium/pomerium#4918) won't be released until v0.26 at the earliest.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kenjenkins thanks for letting me know. I don't see a purpose in backporting these changes unless we want the idp fragments to be available in v25 for some reason?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's nice for the reference table entries to link directly to the corresponding setting documentation, but I agree it's not a major issue, so if you want to skip backporting this PR I think that would be fine as well.

"id": "client-certificate-authority",
"title": "Client Certificate Authority",
"path": "/certificates",
"services": [],
"short_description": "Client certificate authority relative file location string",
"type": "string"
},
"downstream-mtls-client-certificate-authority": {
"id": "downstream-mtls-client-certificate-authority",
"title": "Downstream mTLS Certificate Authority",
Expand Down Expand Up @@ -280,7 +272,7 @@
"id": "polling-max-delay",
"title": "Max Polling Delay",
"path": "/identity-provider-settings#identity-provider-polling-minmax-delay",
"description": "Minimum delay between requests to the IdP Directory.",
"description": "Maximum delay between requests to the IdP Directory.",
"type": "string"
},
"javascript-security": {
Expand Down Expand Up @@ -585,31 +577,31 @@
"identity-provider-client-id": {
"id": "identity-provider-client-id",
"title": "Identity Provider Client ID",
"path": "/identity-provider-settings",
"path": "/identity-provider-settings#identity-provider-client-id",
"description": "Client ID is the OAuth 2.0 Client Identifier retrieved from your identity provider.",
"services": [],
"type": "string"
},
"identity-provider-client-secret-file": {
"id": "identity-provider-client-secret-file",
"title": "Identity Provider Client Secret File",
"path": "/identity-provider-settings",
"path": "/identity-provider-settings#identity-provider-client-secret-file",
"description": "File path containing the client secret, the OAuth 2.0 Secret Identifier retrieved from your identity provider.",
"services": [],
"type": "string"
},
"identity-provider-client-secret": {
"id": "identity-provider-client-secret",
"title": "Identity Provider Client Secret",
"path": "/identity-provider-settings",
"path": "/identity-provider-settings#identity-provider-client-secret",
"description": "Client Secret is the OAuth 2.0 Secret Identifier retrieved from your identity provider.",
"services": [],
"type": "string"
},
"identity-provider-name": {
"id": "identity-provider-name",
"title": "Identity Provider Name",
"path": "/identity-provider-settings",
"path": "/identity-provider-settings#identity-provider-name",
"description": "Provider is the short-hand name of a built-in OpenID Connect (oidc) identity provider to be used for authentication.",
"services": [],
"type": "string"
Expand All @@ -626,7 +618,7 @@
"identity-provider-url": {
"id": "identity-provider-url",
"title": "Identity Provider URL",
"path": "/identity-provider-settings",
"path": "/identity-provider-settings#identity-provider-url",
"description": "Provider URL is the base path to an identity provider's OpenID connect discovery document.",
"services": [],
"type": "string"
Expand All @@ -642,7 +634,7 @@
"identity-provider-polling-min-max-delay": {
"id": "identity-provider-min-max-delay",
"title": "Identity Provider Min/Max Delay",
"path": "/identity-provider-settings",
"path": "/identity-provider-settings#identity-provider-polling-minmax-delay",
"description": "Sets the minimum and maximum delay times between requests to the identity provider directory.",
"services": [],
"type": "string"
Expand Down