You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Additional html features don't work (such as the <b> tag), but I am considering that out of scope for this issue.
openapi-generator version
OpenAPI Version 3.1.0
OpenAPI declaration file content or url
openapi: 3.1.0# Case 1: Description is displayed on the same line as the summarypaths:
/api/v1/location/{location_id}:
get:
summary: Specific Authorized Locationdescription: > Retrieve data for a single location identified by the `location_id` provided, if the user is authorized to access the location.operationId: getLocationparameters: [ ... ]responses: [ ... ]# Case 2: Newlines are ignoredcomponents:
schemas:
Alert:
type: objectdescription: > An alert indicating that something is not behaving as expectedproperties:
severity:
type: string# See: https://github.com/OAI/OpenAPI-Specification/issues/348description: | The severity of the alert. * `alarm` - Action is urgently required. * `alert` - Actions should be taken to fix the problem. * `intrigue` - Low-severity alert; things are not functioning as they should.enum: [ alarm, alert, intrigue ]required: [ severity ]
Generation Details
I am using the openapi_generator pub package, which I understand to be a simple wrapper around the java implementation.
Steps to reproduce
The above sample generates the following client code:
Case 1:
/// Specific Authorized Location /// Retrieve data for a single location identified by the `location_id` provided, if the user is authorized to access the location. /// /// Parameters: /// * ... /// /// Returns a [Future] containing a [Response] with a [LocationData] as data /// Throws [DioException] if API call or serialization failsFuture<Response<LocationData>> getLocation({ ... })
which incorrectly renders as:
Specific Authorized Location Retrieve data for a single location identified by the `location_id` provided, if the user is authorized to access the location.
Case 2:
/// An alert indicating that something is not behaving as expected////// Properties:/// * [severity] - The severity of the alert. * `alarm` - Action is urgently required. * `alert` - Actions should be taken to fix the problem. * `intrigue` - Low-severity alert; things are not functioning as they should.@BuiltValue()
abstractclassAlertimplementsBuilt<Alert, AlertBuilder> {
...
}
(The enum description is correctly displayed in the Swagger UI preview from the IntelliJ OpenAPI Specifications plugin)
Related issues/PRs
Suggest a fix
I believe that the dart generator is stripping newline characters and failing to un-escape symbols like ` and <>.
The text was updated successfully, but these errors were encountered:
Bug Report Checklist
Description
I am having trouble getting basic doc formatting to work with the Dart code generator.
It seems that newlines are not being respected in multi line strings
Additional html features don't work (such as the
<b>
tag), but I am considering that out of scope for this issue.openapi-generator version
OpenAPI Version 3.1.0
OpenAPI declaration file content or url
Generation Details
I am using the openapi_generator pub package, which I understand to be a simple wrapper around the java implementation.
Steps to reproduce
The above sample generates the following client code:
Case 1:
which incorrectly renders as:
Case 2:
(The enum description is correctly displayed in the Swagger UI preview from the IntelliJ OpenAPI Specifications plugin)
Related issues/PRs
Suggest a fix
I believe that the dart generator is stripping newline characters and failing to un-escape symbols like ` and <>.
The text was updated successfully, but these errors were encountered: