Camunda Run: Offer a common way to disable the generated wadl of the rest api

[jonathanlukas]

User Story (Required on creation)

As a infrastructure engineer, I want to be able to disable the wadl file of the rest api in a common way (via property).

Functional Requirements (Required before implementation)

Technical Requirements (Required before implementation)

• A new Camunda Run property called disableWadl (TBD by dev) exists.
• If the property is true, then the CustomJerseyResourceConfig disables the wadl page using the below mentioned jersey property.
• Property can be added to the docs/user guide.

Limitations of Scope

This FR should only be valid for Camunda Run, if it would affect the spring-boot-starter, nobody would be mad after all

Hints

@danielkelemen already made a proposal on the possible fix, you only need to find a place where a new property could be mapped:

public static class CustomJerseyResourceConfig extends CamundaJerseyResourceConfig {
    public CustomJerseyResourceConfig(CamundaJerseyProperties properties) {
      setProperties(Collections.singletonMap("jersey.config.server.wadl.disableWadl", properties.isDisableWadl()));
    }
  }

  @Bean
  public CamundaJerseyResourceConfig createRestConfig(CamundaJerseyProperties properties) {
    return new CustomJerseyResourceConfig(properties);
  }

Links

https://camunda.slack.com/archives/C6M6X3EKZ/p1721627045401189

Breakdown

Pull Requests

Beta Give feedback

1. Camunda Run: Offer a common way to disable the generated wadl of the rest api #4560
   ci:rest-api ci:run +2
   
2. chore(camunda-bpm-run): Add WADL Config Docs camunda-docs-manual#1678
   +0
   

Dev2QA handover

• Does this ticket need a QA test and the testing goals are not clear from the description? Add a Dev2QA handover comment

Testing instructions:

The testing of the feature can be done by running camunda-run distribution and configuring the new property in production.yml in the following scenarios:

• When the Distro is downloaded Then the camunda.bpm.run.rest.disable-wadl is set to true by default in production (ref)
• When camunda.bpm.run.rest.disable-wadl is set to true Then the endpoint /application.wadl returns a 404 response
• Whencamunda.bpm.run.rest.disable-wadl is set to false; Then the endpoint /application.wadl returns the WADL file content
• Whencamunda.bpm.run.rest.disable-wadl is not set Then the endpoint /application.wadl returns the WADL file content

Reference: User Guide | Camunda Run | Choose between default and production configuration

[danielkelemen]

@tasso94, assigning for prioritization.

[tasso94]

Hi @jonathanlukas,

Do you want to contribute this and raise a PR?

Best,
Tassilo

[psavidis]

Assigning the ticket to @danielkelemen for the review of the docs PR

[psavidis]

Assigning to @gbetances089 for the Testing

[gbetances089]

Tested on camunda-bpm-run-ee-7.22.0-20240917.170308-93

Wadl URL: http://localhost:8080/engine-rest/application.wadl