flowable / flowable/flowable-engine

something is broken with OpenApi definition files

Aperta
#2,402 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Java
Stelle
9.5k
Fork
2.9k
Merge medio
7h 8m
PR unite (30g)
2

Descrizione

**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

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Iniziare dai file di definizione OpenAPI e Swagger utilizzati dagli endpoint REST di Flowable, concentrandosi sull’entry point uploadDeployment e sui parametri sort. Confrontare i relativi formati delle richieste e i parametri order, start e size disponibili con le API sottostanti. Il lavoro è completato quando i client PHP generati possono creare deployments e utilizzare le opzioni documentate di ordinamento e paginazione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
java, openapi, php
Ambito
api, backend
Tipo di issue
Bug
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
30/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.