Skip to content

Commit 5f714d1

Browse files
hhundhhund
committed
Merge remote-tracking branch
'origin/issue/309_DocumentationGenerator_for_v2' into develop_2
2 parents 583fb69 + b5eef9c commit 5f714d1

File tree

8 files changed

+213
-77
lines changed

8 files changed

+213
-77
lines changed

‎dsf-bpe/dsf-bpe-test-plugin-v1/pom.xml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,25 @@
2424
<version>${crypto-utils.version.v1}</version>
2525
</dependency>
2626
</dependencies>
27+
28+
<build>
29+
<plugins>
30+
<plugin>
31+
<groupId>dev.dsf</groupId>
32+
<artifactId>dsf-tools-documentation-generator</artifactId>
33+
<executions>
34+
<execution>
35+
<goals>
36+
<goal>generate</goal>
37+
</goals>
38+
</execution>
39+
</executions>
40+
<configuration>
41+
<workingPackages>
42+
<workingPackage>dev.dsf.bpe.test.spring.config</workingPackage>
43+
</workingPackages>
44+
</configuration>
45+
</plugin>
46+
</plugins>
47+
</build>
2748
</project>

‎dsf-bpe/dsf-bpe-test-plugin-v1/src/main/java/dev/dsf/bpe/test/spring/config/Config.java‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,16 @@
1717
import dev.dsf.bpe.test.service.ProxyTest;
1818
import dev.dsf.bpe.test.service.TestActivitySelector;
1919
import dev.dsf.bpe.v1.ProcessPluginApi;
20+
import dev.dsf.bpe.v1.documentation.ProcessDocumentation;
2021

2122
@Configuration
2223
public class Config implements InitializingBean
2324
{
25+
@ProcessDocumentation(description = "Mandatory property", example = "foo", required = true)
2426
@Value("${dev.dsf.bpe.test.env.mandatory:#{null}}")
2527
private String envVariableMandatory;
2628

29+
@ProcessDocumentation(description = "Property with default value", recommendation = "Override default value if necessary")
2730
@Value("${dev.dsf.bpe.test.env.optional:default-value}")
2831
private String envVariableOptional;
2932

‎dsf-bpe/dsf-bpe-test-plugin-v2/pom.xml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,25 @@
1919
<artifactId>dsf-bpe-process-api-v2</artifactId>
2020
</dependency>
2121
</dependencies>
22+
23+
<build>
24+
<plugins>
25+
<plugin>
26+
<groupId>dev.dsf</groupId>
27+
<artifactId>dsf-tools-documentation-generator</artifactId>
28+
<executions>
29+
<execution>
30+
<goals>
31+
<goal>generate</goal>
32+
</goals>
33+
</execution>
34+
</executions>
35+
<configuration>
36+
<workingPackages>
37+
<workingPackage>dev.dsf.bpe.test.spring.config</workingPackage>
38+
</workingPackages>
39+
</configuration>
40+
</plugin>
41+
</plugins>
42+
</build>
2243
</project>

‎dsf-bpe/dsf-bpe-test-plugin-v2/src/main/java/dev/dsf/bpe/test/spring/config/Config.java‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,18 @@
3434
import dev.dsf.bpe.test.service.OrganizationProviderTest;
3535
import dev.dsf.bpe.test.service.ProxyTest;
3636
import dev.dsf.bpe.test.service.TestActivitySelector;
37+
import dev.dsf.bpe.v2.documentation.ProcessDocumentation;
3738
import dev.dsf.bpe.v2.fhir.FhirResourceModifier;
3839
import dev.dsf.bpe.v2.spring.ActivityPrototypeBeanCreator;
3940

4041
@Configuration
4142
public class Config implements InitializingBean
4243
{
44+
@ProcessDocumentation(description = "Mandatory property", example = "foo", required = true)
4345
@Value("${dev.dsf.bpe.test.env.mandatory:#{null}}")
4446
private String envVariableMandatory;
4547

48+
@ProcessDocumentation(description = "Property with default value", recommendation = "Override default value if necessary")
4649
@Value("${dev.dsf.bpe.test.env.optional:default-value}")
4750
private String envVariableOptional;
4851

‎dsf-common/dsf-common-jetty/src/main/java/dev/dsf/common/config/AbstractJettyConfig.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ public abstract class AbstractJettyConfig
115115
@Value("${dev.dsf.server.certificate.key.password:#{null}}")
116116
private char[] serverCertificateKeyFilePassword;
117117

118-
@Documentation(description = "Set to `true` to enable OIDC authorization code flow", recommendation = "Requires *DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_REALM_BASE_URL*, *DEV_DSF_SERVER_AUTH_OIDC_CLIENT_ID* and *DEV_DSF_SERVER_AUTH_OIDC_CLIENT_SECRET* to be specified")
118+
@Documentation(description = "Set to `true` to enable OIDC authorization code flow", recommendation = "Requires *DEV_DSF_SERVER_AUTH_OIDC_PROVIDER_REALM_BASE_URL*, *DEV_DSF_SERVER_AUTH_OIDC_CLIENT_ID* and *DEV_DSF_SERVER_AUTH_OIDC_CLIENT_SECRET* or *DEV_DSF_SERVER_AUTH_OIDC_CLIENT_SECRET_FILE* to be specified")
119119
@Value("${dev.dsf.server.auth.oidc.authorization.code.flow:false}")
120120
private boolean oidcAuthorizationCodeFlowEnabled;
121121

‎dsf-tools/dsf-tools-documentation-generator/pom.xml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@
3535
<groupId>dev.dsf</groupId>
3636
<artifactId>dsf-bpe-process-api-v1</artifactId>
3737
</dependency>
38+
<dependency>
39+
<groupId>dev.dsf</groupId>
40+
<artifactId>dsf-bpe-process-api-v2</artifactId>
41+
</dependency>
3842

3943
<dependency>
4044
<groupId>org.camunda.bpm.model</groupId>

0 commit comments

Comments
 (0)