flowable / flowable/flowable-engine

something is broken with OpenApi definition files

Offen
#2,402 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Java
Sterne
9.5k
Forks
2.9k
Ø Merge
7 Std. 8 Min.
Gemergte PRs (30 T.)
2

Beschreibung

**Describe the bug**
I have used [OpenApi generator](https://openapi-generator.tech/) to generate a PHP client for Flowable. Normal requests work, but When trying to create a deployment (uploadDeployment) I'm greeted by this response:

`{"message":"Internal server error","exception":"Content type 'application/octet-stream' not supported"}`

I think that this stems from this section of the OpenApi definition file:

BinaryAttachment:
content:
application/octet-stream:
schema:
type: string
format: binary
required: true

Whereas the Swagger version (which works fine) is:

- name: "file"
in: "formData"
required: true
type: "file"`

**Expected behavior**
The definition should match the required request format for the application endpoints

**Additional context**
Flowable-rest 6.5.0.6, Tomcat 7, CentOS 7, all stock

for some reason, I can't open another issue but here is something else I've noticed:

**Describe the bug**
Swagger definition files miss the optional sort parameters for sort direction and paging
I had to fix the definitions with a regex adding this chunk afeter every "sort" parameter

- name: "order"
in: "query"
description: "asc or desc"
required: false
type: "string"
enum:
- "asc"
- "desc"
- name: "start"
in: "query"
description: "paging start"
required: false
type: "integer"
- name: "size"
in: "query"
description: "page size"
required: false
type: "integer"`

**Expected behavior**
The definition files should include all the parameters which can be used with the underlying APIs

**Additional context**
flowable-rest 6.5.0.6 stock deployed in tomcat 7 / Centos 7

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Beginnen Sie mit den OpenAPI- und Swagger-Definitionsdateien, die von den Flowable-REST-Endpunkten verwendet werden, und konzentrieren Sie sich auf den uploadDeployment-Einstiegspunkt und die sort-Parameter. Vergleichen Sie deren Anfrageformate und verfügbaren order-, start- und size-Parameter mit den zugrunde liegenden APIs. Als abgeschlossen gilt die Aufgabe, wenn generierte PHP-Clients Deployments erstellen und die dokumentierten Sortier- und Paging-Optionen verwenden können.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
java, openapi, php
Bereich
api, backend
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
30/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.