search

camunda / camunda-bpm-platform

Flexible framework for workflow and decision automation with BPMN and DMN. Integration with Quarkus, Spring, Spring Boot, CDI.
https://camunda.com/
Apache License 2.0
4.09k stars 1.54k forks source link

openapi.json schema incorrect #4554

Open TimoKramer opened 3 weeks ago

TimoKramer commented 3 weeks ago

Environment (Required on creation)

Latest docker image with CAMUNDA_VERSION=7.21.0

Description (Required on creation; please attach any relevant screenshots, stacktraces, log files, etc. to the ticket)

The openapi parser that I am using blows up when reading your openapi.json. I found the problem in your openapi.json and kindly ask you to fix the small issue. I wouldn't be able to use the parser if not. image

Steps to reproduce (Required on creation)

Run docker run -d --name camunda -p 8080:8080 camunda/camunda-bpm-platform:latest

Observed Behavior (Required on creation)

incorrect schema for /metrics

Expected behavior (Required on creation)

correct schema for /metrics

Root Cause (Required on prioritization)

The openapi.json has a route /metrics where the get request takes as 6th parameter an interval in the query. A schema is defined for this parameter with type string and default 900. The 900 is a number here in the json and not a string. That unfortunately blows my parser.

Solution Ideas

I am not sure if this is really supposed to be a string because the unit is seconds. So maybe change the schema to integer maybe?

Hints

Change the schema of parameter 6 for /metrics to integer

Links

Breakdown

### Pull Requests
- [ ] https://github.com/camunda/camunda-bpm-platform/pull/4555

Dev2QA handover

danielkelemen commented 2 weeks ago

Hi @TimoKramer,

Thank you for opening the issue! This part is quite old already (introduced in 2020) and people don't seem to have problems with it. Could you try tweaking your OpenAPI parser maybe? Which parser do you use?

I just noticed that you already created PR as well. That's great and I'll review it soon.

-Daniel