Skip to content

Commit 3861bd0

Browse files
actions-useractions-user
committed
Sync documentation of main branch
1 parent 8c5778a commit 3861bd0

File tree

3 files changed

+197
-194
lines changed

3 files changed

+197
-194
lines changed

‎_generated-doc/main/config/quarkus-all-config.adoc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18159,6 +18159,10 @@ endif::add-copy-button-to-env-var[]
1815918159
|
1816018160

1816118161

18162+
h|[.configroot-name]##Management interface##
18163+
h|Type
18164+
h|Default
18165+
1816218166
a|icon:lock[title=Fixed at build time] [[quarkus-vertx-http_quarkus-management-enabled]] [.property-path]##link:#quarkus-vertx-http_quarkus-management-enabled[`quarkus.management.enabled`]##
1816318167
ifdef::add-copy-button-to-config-props[]
1816418168
config_property_copy_button:+++quarkus.management.enabled+++[]

‎_generated-doc/main/infra/quarkus-all-build-items.adoc‎

Lines changed: 181 additions & 181 deletions
Original file line numberDiff line numberDiff line change
@@ -4088,6 +4088,187 @@ _No Javadoc found_
40884088
_No Javadoc found_
40894089

40904090

4091+
|===
4092+
== Dev UI SPI
4093+
[.configuration-reference,cols=2*]
4094+
|===
4095+
h|Class Name
4096+
h|Attributes
4097+
4098+
4099+
4100+
4101+
a|icon:building[title=Non-instantiatable Build Item (can be inherited from)] https://github.com/quarkusio/quarkus/blob/main/extensions/devui/deployment-spi/src/main/java/io/quarkus/devui/spi/AbstractDevUIBuildItem.java[`io.quarkus.devui.spi.AbstractDevUIBuildItem`, window="_blank"]
4102+
[.description]
4103+
--
4104+
For All DEV UI Build Item, we need to distinguish between the extensions, and the internal usage of Dev UI
4105+
-- a|`java.lang.Class<?> callerClass`
4106+
4107+
_No Javadoc found_
4108+
4109+
`java.lang.String extensionIdentifier`
4110+
4111+
_No Javadoc found_
4112+
4113+
`java.lang.String customIdentifier`
4114+
4115+
_No Javadoc found_
4116+
4117+
4118+
4119+
4120+
a|icon:building[title=Non-instantiatable Build Item (can be inherited from)] https://github.com/quarkusio/quarkus/blob/main/extensions/devui/deployment-spi/src/main/java/io/quarkus/devui/spi/page/AbstractPageBuildItem.java[`io.quarkus.devui.spi.page.AbstractPageBuildItem`, window="_blank"]
4121+
[.description]
4122+
--
4123+
Any of card, menu or footer pages
4124+
-- a|`java.util.Map<String,Object> buildTimeData`
4125+
4126+
_No Javadoc found_
4127+
4128+
`java.util.List<PageBuilder> pageBuilders`
4129+
4130+
_No Javadoc found_
4131+
4132+
`java.lang.String headlessComponentLink`
4133+
4134+
_No Javadoc found_
4135+
4136+
4137+
4138+
4139+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/devui/deployment-spi/src/main/java/io/quarkus/devui/spi/buildtime/BuildTimeActionBuildItem.java[`io.quarkus.devui.spi.buildtime.BuildTimeActionBuildItem`, window="_blank"]
4140+
[.description]
4141+
--
4142+
Holds any Build time actions for Dev UI the extension has
4143+
-- a|`java.util.List<BuildTimeAction> actions`
4144+
4145+
_No Javadoc found_
4146+
4147+
`java.util.List<BuildTimeAction> subscriptions`
4148+
4149+
_No Javadoc found_
4150+
4151+
4152+
4153+
4154+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/devui/deployment-spi/src/main/java/io/quarkus/devui/spi/page/CardPageBuildItem.java[`io.quarkus.devui.spi.page.CardPageBuildItem`, window="_blank"]
4155+
[.description]
4156+
--
4157+
Add a page (or section) to the Dev UI. This is typically the middle part of the screen. This will also add links to this pages
4158+
-- a|`java.util.Optional<Card> optionalCard`
4159+
4160+
_No Javadoc found_
4161+
4162+
`java.util.List<LibraryLink> libraryVersions`
4163+
4164+
_No Javadoc found_
4165+
4166+
`java.lang.String darkLogo`
4167+
4168+
_No Javadoc found_
4169+
4170+
`java.lang.String lightLogo`
4171+
4172+
_No Javadoc found_
4173+
4174+
4175+
4176+
4177+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/devui/deployment-spi/src/main/java/io/quarkus/devui/spi/buildtime/FooterLogBuildItem.java[`io.quarkus.devui.spi.buildtime.FooterLogBuildItem`, window="_blank"]
4178+
[.description]
4179+
--
4180+
Add a log to the footer of dev ui
4181+
-- a|`java.lang.String name`
4182+
4183+
_No Javadoc found_
4184+
4185+
`java.util.function.Supplier<Flow.Publisher<String>> publisherSupplier`
4186+
4187+
_No Javadoc found_
4188+
4189+
`io.quarkus.runtime.RuntimeValue<SubmissionPublisher<String>> runtimePublisher`
4190+
4191+
_No Javadoc found_
4192+
4193+
4194+
4195+
4196+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/devui/deployment-spi/src/main/java/io/quarkus/devui/spi/page/FooterPageBuildItem.java[`io.quarkus.devui.spi.page.FooterPageBuildItem`, window="_blank"]
4197+
[.description]
4198+
--
4199+
Add a footer tab to the Dev UI.
4200+
-- a|None
4201+
4202+
4203+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/devui/deployment-spi/src/main/java/io/quarkus/devui/spi/JsonRPCProvidersBuildItem.java[`io.quarkus.devui.spi.JsonRPCProvidersBuildItem`, window="_blank"]
4204+
[.description]
4205+
--
4206+
This allows you to register a class that will provide data during runtime for JsonRPC Requests.
4207+
Note that this build item should <em>not</em> be produced only in dev mode (e.g. using `@BuildStep(onlyIf = IsDevelopment.class)` ), because it is also used to discover valid usages of execution model affecting annotations (see `io.quarkus.deployment.execannotations.ExecutionModelAnnotationsAllowedBuildItem` ).
4208+
-- a|`java.lang.Class jsonRPCMethodProviderClass`
4209+
4210+
_No Javadoc found_
4211+
4212+
`org.jboss.jandex.DotName defaultBeanScope`
4213+
4214+
_No Javadoc found_
4215+
4216+
4217+
4218+
4219+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/devui/deployment-spi/src/main/java/io/quarkus/devui/spi/page/MenuPageBuildItem.java[`io.quarkus.devui.spi.page.MenuPageBuildItem`, window="_blank"]
4220+
[.description]
4221+
--
4222+
Add a menu (or section) to the Dev UI.
4223+
-- a|None
4224+
4225+
4226+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/devui/deployment-spi/src/main/java/io/quarkus/devui/spi/buildtime/QuteTemplateBuildItem.java[`io.quarkus.devui.spi.buildtime.QuteTemplateBuildItem`, window="_blank"]
4227+
[.description]
4228+
--
4229+
Contains info on the build time template used to build static content for Dev UI All files are relative to dev-ui-templates/build-time/{extensionName} (in src/main/resources) This contain the fileName to the template, and the template data (variables) This allows extensions developers to add "static files" that they generate with Qute at build time. From a runtime p.o.v this is file served from "disk"
4230+
-- a|`java.util.List<TemplateData> templateDatas`
4231+
4232+
_No Javadoc found_
4233+
4234+
4235+
4236+
4237+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/devui/deployment-spi/src/main/java/io/quarkus/devui/spi/buildtime/StaticContentBuildItem.java[`io.quarkus.devui.spi.buildtime.StaticContentBuildItem`, window="_blank"]
4238+
[.description]
4239+
--
4240+
Static Content generated at build time This is used to generate components that will be available in Dev UI, but generated during build. This contains the final content (no more generation) and will be served as is
4241+
-- a|`java.util.List<DevUIContent> content`
4242+
4243+
_No Javadoc found_
4244+
4245+
4246+
4247+
4248+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/devui/deployment-spi/src/main/java/io/quarkus/devui/spi/workspace/WorkspaceActionBuildItem.java[`io.quarkus.devui.spi.workspace.WorkspaceActionBuildItem`, window="_blank"]
4249+
[.description]
4250+
--
4251+
Add an action to the Dev UI Workspace.
4252+
-- a|`java.util.List<ActionBuilder> actionBuilders`
4253+
4254+
_No Javadoc found_
4255+
4256+
4257+
4258+
4259+
a| https://github.com/quarkusio/quarkus/blob/main/extensions/devui/deployment-spi/src/main/java/io/quarkus/devui/spi/workspace/WorkspaceBuildItem.java[`io.quarkus.devui.spi.workspace.WorkspaceBuildItem`, window="_blank"]
4260+
[.description]
4261+
--
4262+
This hold all files in the user's project root
4263+
-- a|`java.util.List<WorkspaceItem> workspaceItems`
4264+
4265+
_No Javadoc found_
4266+
4267+
`java.nio.file.Path rootPath`
4268+
4269+
_No Javadoc found_
4270+
4271+
40914272
|===
40924273
== DevServices - Keycloak
40934274
[.configuration-reference,cols=2*]
@@ -9502,187 +9683,6 @@ _No Javadoc found_
95029683
_No Javadoc found_
95039684

95049685

9505-
|===
9506-
== Vert.x - HTTP - Dev UI SPI
9507-
[.configuration-reference,cols=2*]
9508-
|===
9509-
h|Class Name
9510-
h|Attributes
9511-
9512-
9513-
9514-
9515-
a|icon:building[title=Non-instantiatable Build Item (can be inherited from)] https://github.com/quarkusio/quarkus/blob/main/extensions/devui/spi/src/main/java/io/quarkus/devui/spi/AbstractDevUIBuildItem.java[`io.quarkus.devui.spi.AbstractDevUIBuildItem`, window="_blank"]
9516-
[.description]
9517-
--
9518-
For All DEV UI Build Item, we need to distinguish between the extensions, and the internal usage of Dev UI
9519-
-- a|`java.lang.Class<?> callerClass`
9520-
9521-
_No Javadoc found_
9522-
9523-
`java.lang.String extensionIdentifier`
9524-
9525-
_No Javadoc found_
9526-
9527-
`java.lang.String customIdentifier`
9528-
9529-
_No Javadoc found_
9530-
9531-
9532-
9533-
9534-
a|icon:building[title=Non-instantiatable Build Item (can be inherited from)] https://github.com/quarkusio/quarkus/blob/main/extensions/devui/spi/src/main/java/io/quarkus/devui/spi/page/AbstractPageBuildItem.java[`io.quarkus.devui.spi.page.AbstractPageBuildItem`, window="_blank"]
9535-
[.description]
9536-
--
9537-
Any of card, menu or footer pages
9538-
-- a|`java.util.Map<String,Object> buildTimeData`
9539-
9540-
_No Javadoc found_
9541-
9542-
`java.util.List<PageBuilder> pageBuilders`
9543-
9544-
_No Javadoc found_
9545-
9546-
`java.lang.String headlessComponentLink`
9547-
9548-
_No Javadoc found_
9549-
9550-
9551-
9552-
9553-
a| https://github.com/quarkusio/quarkus/blob/main/extensions/devui/spi/src/main/java/io/quarkus/devui/spi/buildtime/BuildTimeActionBuildItem.java[`io.quarkus.devui.spi.buildtime.BuildTimeActionBuildItem`, window="_blank"]
9554-
[.description]
9555-
--
9556-
Holds any Build time actions for Dev UI the extension has
9557-
-- a|`java.util.List<BuildTimeAction> actions`
9558-
9559-
_No Javadoc found_
9560-
9561-
`java.util.List<BuildTimeAction> subscriptions`
9562-
9563-
_No Javadoc found_
9564-
9565-
9566-
9567-
9568-
a| https://github.com/quarkusio/quarkus/blob/main/extensions/devui/spi/src/main/java/io/quarkus/devui/spi/page/CardPageBuildItem.java[`io.quarkus.devui.spi.page.CardPageBuildItem`, window="_blank"]
9569-
[.description]
9570-
--
9571-
Add a page (or section) to the Dev UI. This is typically the middle part of the screen. This will also add links to this pages
9572-
-- a|`java.util.Optional<Card> optionalCard`
9573-
9574-
_No Javadoc found_
9575-
9576-
`java.util.List<LibraryLink> libraryVersions`
9577-
9578-
_No Javadoc found_
9579-
9580-
`java.lang.String darkLogo`
9581-
9582-
_No Javadoc found_
9583-
9584-
`java.lang.String lightLogo`
9585-
9586-
_No Javadoc found_
9587-
9588-
9589-
9590-
9591-
a| https://github.com/quarkusio/quarkus/blob/main/extensions/devui/spi/src/main/java/io/quarkus/devui/spi/buildtime/FooterLogBuildItem.java[`io.quarkus.devui.spi.buildtime.FooterLogBuildItem`, window="_blank"]
9592-
[.description]
9593-
--
9594-
Add a log to the footer of dev ui
9595-
-- a|`java.lang.String name`
9596-
9597-
_No Javadoc found_
9598-
9599-
`java.util.function.Supplier<Flow.Publisher<String>> publisherSupplier`
9600-
9601-
_No Javadoc found_
9602-
9603-
`io.quarkus.runtime.RuntimeValue<SubmissionPublisher<String>> runtimePublisher`
9604-
9605-
_No Javadoc found_
9606-
9607-
9608-
9609-
9610-
a| https://github.com/quarkusio/quarkus/blob/main/extensions/devui/spi/src/main/java/io/quarkus/devui/spi/page/FooterPageBuildItem.java[`io.quarkus.devui.spi.page.FooterPageBuildItem`, window="_blank"]
9611-
[.description]
9612-
--
9613-
Add a footer tab to the Dev UI.
9614-
-- a|None
9615-
9616-
9617-
a| https://github.com/quarkusio/quarkus/blob/main/extensions/devui/spi/src/main/java/io/quarkus/devui/spi/JsonRPCProvidersBuildItem.java[`io.quarkus.devui.spi.JsonRPCProvidersBuildItem`, window="_blank"]
9618-
[.description]
9619-
--
9620-
This allows you to register a class that will provide data during runtime for JsonRPC Requests.
9621-
Note that this build item should <em>not</em> be produced only in dev mode (e.g. using `@BuildStep(onlyIf = IsDevelopment.class)` ), because it is also used to discover valid usages of execution model affecting annotations (see `io.quarkus.deployment.execannotations.ExecutionModelAnnotationsAllowedBuildItem` ).
9622-
-- a|`java.lang.Class jsonRPCMethodProviderClass`
9623-
9624-
_No Javadoc found_
9625-
9626-
`org.jboss.jandex.DotName defaultBeanScope`
9627-
9628-
_No Javadoc found_
9629-
9630-
9631-
9632-
9633-
a| https://github.com/quarkusio/quarkus/blob/main/extensions/devui/spi/src/main/java/io/quarkus/devui/spi/page/MenuPageBuildItem.java[`io.quarkus.devui.spi.page.MenuPageBuildItem`, window="_blank"]
9634-
[.description]
9635-
--
9636-
Add a menu (or section) to the Dev UI.
9637-
-- a|None
9638-
9639-
9640-
a| https://github.com/quarkusio/quarkus/blob/main/extensions/devui/spi/src/main/java/io/quarkus/devui/spi/buildtime/QuteTemplateBuildItem.java[`io.quarkus.devui.spi.buildtime.QuteTemplateBuildItem`, window="_blank"]
9641-
[.description]
9642-
--
9643-
Contains info on the build time template used to build static content for Dev UI All files are relative to dev-ui-templates/build-time/{extensionName} (in src/main/resources) This contain the fileName to the template, and the template data (variables) This allows extensions developers to add "static files" that they generate with Qute at build time. From a runtime p.o.v this is file served from "disk"
9644-
-- a|`java.util.List<TemplateData> templateDatas`
9645-
9646-
_No Javadoc found_
9647-
9648-
9649-
9650-
9651-
a| https://github.com/quarkusio/quarkus/blob/main/extensions/devui/spi/src/main/java/io/quarkus/devui/spi/buildtime/StaticContentBuildItem.java[`io.quarkus.devui.spi.buildtime.StaticContentBuildItem`, window="_blank"]
9652-
[.description]
9653-
--
9654-
Static Content generated at build time This is used to generate components that will be available in Dev UI, but generated during build. This contains the final content (no more generation) and will be served as is
9655-
-- a|`java.util.List<DevUIContent> content`
9656-
9657-
_No Javadoc found_
9658-
9659-
9660-
9661-
9662-
a| https://github.com/quarkusio/quarkus/blob/main/extensions/devui/spi/src/main/java/io/quarkus/devui/spi/workspace/WorkspaceActionBuildItem.java[`io.quarkus.devui.spi.workspace.WorkspaceActionBuildItem`, window="_blank"]
9663-
[.description]
9664-
--
9665-
Add an action to the Dev UI Workspace.
9666-
-- a|`java.util.List<ActionBuilder> actionBuilders`
9667-
9668-
_No Javadoc found_
9669-
9670-
9671-
9672-
9673-
a| https://github.com/quarkusio/quarkus/blob/main/extensions/devui/spi/src/main/java/io/quarkus/devui/spi/workspace/WorkspaceBuildItem.java[`io.quarkus.devui.spi.workspace.WorkspaceBuildItem`, window="_blank"]
9674-
[.description]
9675-
--
9676-
This hold all files in the user's project root
9677-
-- a|`java.util.List<WorkspaceItem> workspaceItems`
9678-
9679-
_No Javadoc found_
9680-
9681-
`java.nio.file.Path rootPath`
9682-
9683-
_No Javadoc found_
9684-
9685-
96869686
|===
96879687
== Vert.x - HTTP - SPI
96889688
[.configuration-reference,cols=2*]

0 commit comments

Comments
 (0)