-
Notifications
You must be signed in to change notification settings - Fork 71
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.
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
feat: add custom annotation for configuration property and feature flag documentation #2852
Merged
Merged
Changes from 35 commits
Commits
Show all changes
39 commits
Select commit
Hold shift + click to select a range
5459897
feat: add custom annotation for prop documentation
ossdhaval e1e6b43
feat: add annotation processor
ossdhaval 16087e2
feat: annotate properties
ossdhaval 95a8e96
feat: configure annotation processor
ossdhaval ff17f3e
feat: add default value
ossdhaval 0a38a73
feat: add annotation to enum
ossdhaval a7882a0
feat: add comment
ossdhaval b88e451
feat: rename annotation
ossdhaval ce9f62d
feat: rename processor class
ossdhaval e41b092
feat: refactor to new core module
ossdhaval 3d6c26d
feat: fix test class errors
ossdhaval 6c22174
feat: rename the module
ossdhaval 26d6e5d
feat: add table and details view of content
ossdhaval a2815d9
feat: sort properties
ossdhaval bb649f7
feat: change wording - mandatory to required
ossdhaval 3f5ff38
feat: add exception handling and logging
ossdhaval b0f1d9b
feat: write file under classes output dir
ossdhaval 37ea1d9
feat: create output file under target directory
ossdhaval ff68f2b
feat: rename property and file
ossdhaval d33c256
feat: create separate annotation for feature flags
ossdhaval 17f57db
feat: code cleanup
ossdhaval 1c432de
fix: add description to properties
ossdhaval d455f19
fix: add property descriptions from Gluu docs
ossdhaval 3885aac
fix: add descriptions from Swagger
ossdhaval 4b74744
fix(fido2): annotate fido config properties
ossdhaval fba3013
feat(scim): configure property documentation annotations
ossdhaval 93cacc8
fix: add module name to file and title
ossdhaval 537fb68
fix: add Feature Flag descriptions
ossdhaval d04317a
fix: integrate doc generation with CI
ossdhaval 33424c2
fix: add tags to generated docs
ossdhaval b5f245d
fix: create separate sections for properties and flags
ossdhaval a570f80
Merge branch 'main' into properties-doc-automation
ossdhaval 62e1f10
fix: update the artifact version for jans-doc
ossdhaval 8b5abb9
fix: contents of markdown files after merge
ossdhaval 498c889
ci: remove token req
moabu bb1d0e4
fix: sonar issues
ossdhaval 94d0703
fix: sonar issues
ossdhaval 9c70e0e
fix: sonar issues
ossdhaval 240ea9c
fix: move doc generation to shell script
ossdhaval File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Overview | ||
|
||
Please use the left navigation menu to browse the content of this section while we are still working on developing content for `Overview` page. | ||
|
||
!!! Contribute | ||
If you’d like to contribute to this document, get started with the [Contribution Guide](https://docs.jans.io/head/CONTRIBUTING/#contributing-to-the-documentation) |
214 changes: 214 additions & 0 deletions
214
docs/admin/reference/json/feature-flags/janssenauthserver-feature-flags.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,214 @@ | ||
--- | ||
tags: | ||
- administration | ||
- reference | ||
- json | ||
- feature-flags | ||
--- | ||
|
||
# Janssen Auth Server Feature Flags | ||
|
||
| Feature Flag Name | Description | | | ||
|-----|-----|-----| | ||
| ACTIVE_SESSION | Enable/Disable active session endpoint | [Details](#active_session) | | ||
| CIBA | Enable/Disable OpenID Connect Client Initiated Backchannel Authentication Flow(CIBA) flow support | [Details](#ciba) | | ||
| CLIENTINFO | Enable/Disable client info endpoint | [Details](#clientinfo) | | ||
| DEVICE_AUTHZ | Enable/Disable support for device authorization | [Details](#device_authz) | | ||
| END_SESSION | Enable/Disable end session endpoint | [Details](#end_session) | | ||
| HEALTH_CHECK | Enable/Disable health-check endpoint | [Details](#health_check) | | ||
| ID_GENERATION | Enable/Disable ID Generation endpoint | [Details](#id_generation) | | ||
| INTROSPECTION | Enable/Disable token introspection endpoint | [Details](#introspection) | | ||
| JANS_CONFIGURATION | Enable/Disable *.well-known* configuration endpoint | [Details](#jans_configuration) | | ||
| METRIC | Enable/Disable metric reporter feature | [Details](#metric) | | ||
| PAR | Enable/Disable Pushed Authorization Requests(PAR) feature | [Details](#par) | | ||
| REGISTRATION | Enable/Disable client registration endpoint | [Details](#registration) | | ||
| REVOKE_SESSION | Enable/Disable session revocation endpoint | [Details](#revoke_session) | | ||
| REVOKE_TOKEN | Enable/Disable token revocation endpoint | [Details](#revoke_token) | | ||
| SSA | Enable/Disable Software Statement Assertion(SSA) feature | [Details](#ssa) | | ||
| STAT | Enable/Disable Stat service | [Details](#stat) | | ||
| STATUS_SESSION | Enable/Disable session status check endpoint | [Details](#status_session) | | ||
| U2F | Enable/Disable support for Universal 2nd Factor(U2F) protocol | [Details](#u2f) | | ||
| UMA | Enable/Disable support for User-Managed Access (UMA) | [Details](#uma) | | ||
| USERINFO | Enable/Disable OpenID Connect [userinfo endpoint](https://openid.net/specs/openid-connect-core-1_0.html#UserInfo) | [Details](#userinfo) | | ||
|
||
|
||
### ACTIVE_SESSION | ||
|
||
- Description: Enable/Disable active session endpoint | ||
|
||
- Required: No | ||
|
||
- Default value: None | ||
|
||
|
||
### CIBA | ||
|
||
- Description: Enable/Disable OpenID Connect Client Initiated Backchannel Authentication Flow(CIBA) flow support | ||
|
||
- Required: No | ||
|
||
- Default value: None | ||
|
||
|
||
### CLIENTINFO | ||
|
||
- Description: Enable/Disable client info endpoint | ||
|
||
- Required: No | ||
|
||
- Default value: None | ||
|
||
|
||
### DEVICE_AUTHZ | ||
|
||
- Description: Enable/Disable support for device authorization | ||
|
||
- Required: No | ||
|
||
- Default value: None | ||
|
||
|
||
### END_SESSION | ||
|
||
- Description: Enable/Disable end session endpoint | ||
|
||
- Required: No | ||
|
||
- Default value: None | ||
|
||
|
||
### HEALTH_CHECK | ||
|
||
- Description: Enable/Disable health-check endpoint | ||
|
||
- Required: No | ||
|
||
- Default value: None | ||
|
||
|
||
### ID_GENERATION | ||
|
||
- Description: Enable/Disable ID Generation endpoint | ||
|
||
- Required: No | ||
|
||
- Default value: None | ||
|
||
|
||
### INTROSPECTION | ||
|
||
- Description: Enable/Disable token introspection endpoint | ||
|
||
- Required: No | ||
|
||
- Default value: None | ||
|
||
|
||
### JANS_CONFIGURATION | ||
|
||
- Description: Enable/Disable *.well-known* configuration endpoint | ||
|
||
- Required: No | ||
|
||
- Default value: None | ||
|
||
|
||
### METRIC | ||
|
||
- Description: Enable/Disable metric reporter feature | ||
|
||
- Required: No | ||
|
||
- Default value: None | ||
|
||
|
||
### PAR | ||
|
||
- Description: Enable/Disable Pushed Authorization Requests(PAR) feature | ||
|
||
- Required: No | ||
|
||
- Default value: None | ||
|
||
|
||
### REGISTRATION | ||
|
||
- Description: Enable/Disable client registration endpoint | ||
|
||
- Required: No | ||
|
||
- Default value: None | ||
|
||
|
||
### REVOKE_SESSION | ||
|
||
- Description: Enable/Disable session revocation endpoint | ||
|
||
- Required: No | ||
|
||
- Default value: None | ||
|
||
|
||
### REVOKE_TOKEN | ||
|
||
- Description: Enable/Disable token revocation endpoint | ||
|
||
- Required: No | ||
|
||
- Default value: None | ||
|
||
|
||
### SSA | ||
|
||
- Description: Enable/Disable Software Statement Assertion(SSA) feature | ||
|
||
- Required: No | ||
|
||
- Default value: None | ||
|
||
|
||
### STAT | ||
|
||
- Description: Enable/Disable Stat service | ||
|
||
- Required: No | ||
|
||
- Default value: None | ||
|
||
|
||
### STATUS_SESSION | ||
|
||
- Description: Enable/Disable session status check endpoint | ||
|
||
- Required: No | ||
|
||
- Default value: None | ||
|
||
|
||
### U2F | ||
|
||
- Description: Enable/Disable support for Universal 2nd Factor(U2F) protocol | ||
|
||
- Required: No | ||
|
||
- Default value: None | ||
|
||
|
||
### UMA | ||
|
||
- Description: Enable/Disable support for User-Managed Access (UMA) | ||
|
||
- Required: No | ||
|
||
- Default value: None | ||
|
||
|
||
### USERINFO | ||
|
||
- Description: Enable/Disable OpenID Connect [userinfo endpoint](https://openid.net/specs/openid-connect-core-1_0.html#UserInfo) | ||
|
||
- Required: No | ||
|
||
- Default value: None | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Overview | ||
|
||
Please use the left navigation menu to browse the content of this section while we are still working on developing content for `Overview` page. | ||
|
||
!!! Contribute | ||
If you’d like to contribute to this document, get started with the [Contribution Guide](https://docs.jans.io/head/CONTRIBUTING/#contributing-to-the-documentation) |
6 changes: 6 additions & 0 deletions
6
docs/admin/reference/json/properties/config-api-properties.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Overview | ||
|
||
Please use the left navigation menu to browse the content of this section while we are still working on developing content for `Overview` page. | ||
|
||
!!! Contribute | ||
If you’d like to contribute to this document, get started with the [Contribution Guide](https://docs.jans.io/head/CONTRIBUTING/#contributing-to-the-documentation) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please inject a bash script at
https://github.com/JanssenProject/jans/tree/main/automation
under a new folderdocs
. This will allow the workflows to be a little bit cleaner as I suspect we will have more of these flows.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@moabu Done. I have moved these commands to a separate script. Please check.