Skip to content

Update AppSec Kit configuration documentation #4641

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update AppSec Kit configuration documentation #4641

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
6 changes: 6 additions & 0 deletions articles/tools/appsec/advanced-topics.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@

You can set or override the following configuration values in the `AppSecConfiguration`:

`vaadinPlatformVersion`::
The Vaadin platform version that the application is using.

Check warning on line 31 in articles/tools/appsec/advanced-topics.adoc

View workflow job for this annotation

GitHub Actions / lint 

[vale] reported by reviewdog 🐶
[Vaadin.VaadinPlatform] Consider using "Vaadin" instead. Use "the Vaadin platform" only if absolutely needed.

Raw Output:
{"message": "[Vaadin.VaadinPlatform] Consider using \"Vaadin\" instead. Use \"the Vaadin platform\" only if absolutely needed.", "location": {"path": "articles/tools/appsec/advanced-topics.adoc", "range": {"start": {"line": 31, "column": 1}}}, "severity": "WARNING"}
`appSecRoute`::
The route of the AppSec Kit user interface.
`dataFilePath`::
Expand All @@ -47,6 +49,10 @@
The boolean value to decide if the server push should be automatically activated in the application.


=== Vaadin Platform Version

Check warning on line 52 in articles/tools/appsec/advanced-topics.adoc

View workflow job for this annotation

GitHub Actions / lint 

[vale] reported by reviewdog 🐶
[Vaadin.VaadinPlatform] Consider using "Vaadin" instead. Use "the Vaadin platform" only if absolutely needed.

Raw Output:
{"message": "[Vaadin.VaadinPlatform] Consider using \"Vaadin\" instead. Use \"the Vaadin platform\" only if absolutely needed.", "location": {"path": "articles/tools/appsec/advanced-topics.adoc", "range": {"start": {"line": 52, "column": 5}}}, "severity": "WARNING"}

Check failure on line 52 in articles/tools/appsec/advanced-topics.adoc

View workflow job for this annotation

GitHub Actions / lint 

[vale] reported by reviewdog 🐶
[Vaadin.VaadinPlatformCase] Don't capitalize "platform", and remember to include the definitive article ("the").

Raw Output:
{"message": "[Vaadin.VaadinPlatformCase] Don't capitalize \"platform\", and remember to include the definitive article (\"the\").", "location": {"path": "articles/tools/appsec/advanced-topics.adoc", "range": {"start": {"line": 52, "column": 5}}}, "severity": "ERROR"}

The AppSec Kit requires the Vaadin platform version that is used in the application when getting the Vaadin platform BOM. First, it checks if the `vaadin-core` dependency is present in the application and uses the version of that dependency as the Vaadin platform version. If the `vaadin-core` dependency is not present then it gets the version defined in the AppSec Kit configuration through this configuration option. If this configuration option is not defined then an `AppSecException` is thrown. The version should be defined as a `String`. The default value is `null`.

Check warning on line 54 in articles/tools/appsec/advanced-topics.adoc

View workflow job for this annotation

GitHub Actions / lint 

[vale] reported by reviewdog 🐶
[Vaadin.VaadinPlatform] Consider using "Vaadin" instead. Use "the Vaadin platform" only if absolutely needed.

Raw Output:
{"message": "[Vaadin.VaadinPlatform] Consider using \"Vaadin\" instead. Use \"the Vaadin platform\" only if absolutely needed.", "location": {"path": "articles/tools/appsec/advanced-topics.adoc", "range": {"start": {"line": 54, "column": 245}}}, "severity": "WARNING"}

Check warning on line 54 in articles/tools/appsec/advanced-topics.adoc

View workflow job for this annotation

GitHub Actions / lint 

[vale] reported by reviewdog 🐶
[Vaadin.VaadinPlatform] Consider using "Vaadin" instead. Use "the Vaadin platform" only if absolutely needed.

Raw Output:
{"message": "[Vaadin.VaadinPlatform] Consider using \"Vaadin\" instead. Use \"the Vaadin platform\" only if absolutely needed.", "location": {"path": "articles/tools/appsec/advanced-topics.adoc", "range": {"start": {"line": 54, "column": 98}}}, "severity": "WARNING"}

Check warning on line 54 in articles/tools/appsec/advanced-topics.adoc

View workflow job for this annotation

GitHub Actions / lint 

[vale] reported by reviewdog 🐶
[Vaadin.VaadinPlatform] Consider using "Vaadin" instead. Use "the Vaadin platform" only if absolutely needed.

Raw Output:
{"message": "[Vaadin.VaadinPlatform] Consider using \"Vaadin\" instead. Use \"the Vaadin platform\" only if absolutely needed.", "location": {"path": "articles/tools/appsec/advanced-topics.adoc", "range": {"start": {"line": 54, "column": 25}}}, "severity": "WARNING"}

=== AppSec Kit Route

You can configure the route of the AppSec Kit user interface. The default value is `vaadin-appsec-kit`.
Expand Down
Loading