[OFBIZ-12344] Additional findings and possible enhancements

• Type: Sub-task
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Affects Version/s: Trunk, Upcoming Branch
• Component/s: rest-api
• Assignee: Michael Brohl
• Reporter: Michael Brohl
• Created: 21/Oct/21 11:44
• Updated: 11/Jan/22 08:48

Description

This is a Jira to collect findings, discussion points and enhancements.

It's primarily a convenience issue to make it easy to put together thoughts and ideas without having to create Jira issues immediately. Once a point gets more shape, a Jira is created for it.

 

Points:

• the ids for the API blocks in the Swagger UI are not taking the verbs into account which leads to same ids for different blocks with the same service name

 

Solved 

• it seems that only the first GET API is displayed in the Swagger UI
• the Swagger UI does not display GET resources with path parameters and subressources like

  /parties/{id}/permissions

• reason for it seems to be that openapi.json does not contain the path while application.wadl has it

           -> the service parameters must match a path parameter else it will not be displayed, which is correct

• the generated openapi.json shows errors in https://editor.swagger.io/
  • "Header parameters named "Authorization" are ignored. Use the `securitySchemes` and `security` sections instead to define authorization."
    I guess the openapi generation must be changed, investigating...
  • "Structural error at paths./....parameters.0 should have either a `schema` or `content` property"
    the generated parameters from the service definition do not have a schema entry generated
  • the same applies to the WWW-Authenticate header in the responses
• it also shows warnings
  • "Header parameters named "Accept" are ignored. The values for the "Accept" header are defined by `responses.<code>.content.<media-type>`."

          -> see OFBIZ-12426

Issue Links

• is related to: OFBIZ-12426 REST-API Plugin: Remove errors and warnings in generated openapi documentation