Switch to predominant use of appDescriptionWithNewLines in README.mustache (#5109)

Descriptions tend to get lengthy and can include multiple lines.
New lines are important to markdown formatting/syntax and can't just be ignored.

Resolves https://github.com/OpenAPITools/openapi-generator/issues/3704
This commit is contained in:
LoveIsGrief
2020-01-29 10:18:57 +01:00
committed by GitHub
parent f4185b8d9e
commit 6cf58afdc5
43 changed files with 122 additions and 122 deletions

View File

@@ -1,8 +1,8 @@
# Eiffel API client for {{packageName}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.

View File

@@ -1,8 +1,8 @@
# {{packageName}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
This Groovy package, using the [http-builder-ng library](https://http-builder-ng.github.io/http-builder-ng/), is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

View File

@@ -8,7 +8,7 @@
- Build date: {{generatedDate}}
{{/hideGenerationTimestamp}}
{{#appDescription}}{{{appDescription}}}{{/appDescription}}
{{#appDescriptionWithNewLines}}{{{appDescriptionWithNewLines}}}{{/appDescriptionWithNewLines}}
{{#infoUrl}}
For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})

View File

@@ -1,9 +1,9 @@
# {{appName}} - MicroProfile Rest Client
{{#appDescription}}
{{{appDescription}}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescription}}
{{/appDescriptionWithNewLines}}
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.
[MicroProfile Rest Client](https://github.com/eclipse/microprofile-rest-client) is a type-safe way of calling

View File

@@ -8,7 +8,7 @@
- Build date: {{generatedDate}}
{{/hideGenerationTimestamp}}
{{#appDescription}}{{{appDescription}}}{{/appDescription}}
{{#appDescriptionWithNewLines}}{{{appDescriptionWithNewLines}}}{{/appDescriptionWithNewLines}}
{{#infoUrl}}
For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})

View File

@@ -6,7 +6,7 @@
- Build date: {{generatedDate}}
{{/hideGenerationTimestamp}}
{{#appDescription}}{{{appDescription}}}{{/appDescription}}
{{#appDescriptionWithNewLines}}{{{appDescriptionWithNewLines}}}{{/appDescriptionWithNewLines}}
{{#infoUrl}}
For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})

View File

@@ -1,9 +1,9 @@
# {{projectName}}
{{moduleName}} - JavaScript client for {{projectName}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: {{appVersion}}

View File

@@ -1,9 +1,9 @@
# {{projectName}}
{{moduleName}} - JavaScript client for {{projectName}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: {{appVersion}}

View File

@@ -1,8 +1,8 @@
# {{packageName}} - ASP.NET Core 2.0 Server
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
## Run

View File

@@ -1,8 +1,8 @@
# {{packageName}} - ASP.NET Core 2.0 Server
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
## Run
@@ -25,4 +25,4 @@ cd {{sourceFolder}}/{{packageName}}
docker build -t {{dockerTag}} .
docker run -p 5000:8080 {{dockerTag}}
```
{{/isLibrary}}
{{/isLibrary}}

View File

@@ -1,8 +1,8 @@
# C++ API client
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI spec](https://openapis.org) from a remote server, you can easily generate an API client.

View File

@@ -1,8 +1,8 @@
# {{packageName}} - the C# library for the {{appName}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
This C# SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

View File

@@ -1,8 +1,8 @@
# {{packageName}} - the C# library for the {{appName}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
This C# SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

View File

@@ -1,8 +1,8 @@
# {{packageName}} - the C# library for the {{appName}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
This C# SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

View File

@@ -1,7 +1,7 @@
# {{pubName}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
This Dart package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

View File

@@ -1,7 +1,7 @@
# {{pubName}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
This Dart package is automatically generated by the [Open API Codegen](https://github.com/OpenAPITools/openapi-generator) project:

View File

@@ -1,7 +1,7 @@
# {{pubName}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
This Dart package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

View File

@@ -1,7 +1,7 @@
# {{pubName}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
This Dart package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

View File

@@ -1,9 +1,9 @@
# Elm API client
{{#appDescription}}
{{{appDescription}}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescription}}
{{/appDescriptionWithNewLines}}
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://github.com/OAI/OpenAPI-Specification) from a remote server, you can easily generate an API client.

View File

@@ -1,8 +1,8 @@
# Go API client for {{packageName}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.

View File

@@ -1,8 +1,8 @@
# Go API Server for {{packageName}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
## Overview
This server was generated by the [openapi-generator]

View File

@@ -1,8 +1,8 @@
# Go API Server for {{packageName}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
## Overview
This server was generated by the [openapi-generator]

View File

@@ -1,8 +1,8 @@
# Go API client for {{packageName}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.

View File

@@ -1,8 +1,8 @@
# GraphQL express API server
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
## Requirements

View File

@@ -1,8 +1,8 @@
# Lua API client for {{packageName}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.

View File

@@ -1,8 +1,8 @@
# Lua API client for {{packageName}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.

View File

@@ -1,8 +1,8 @@
# Nim API client for {{{appName}}} (Package: {{{packageName}}})
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
## Overview

View File

@@ -1,8 +1,8 @@
# {{podName}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
This ObjC package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

View File

@@ -1,7 +1,7 @@
# {{{projectName}}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
This OCaml package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

View File

@@ -2,7 +2,7 @@
{{moduleName}}::Role - a Moose role for the {{appName}}
{{#appDescription}}{{{appDescription}}}{{/appDescription}}
{{#appDescriptionWithNewLines}}{{{appDescriptionWithNewLines}}}{{/appDescriptionWithNewLines}}
# VERSION

View File

@@ -1,7 +1,7 @@
# {{bundleName}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
This [Symfony](https://symfony.com/) bundle is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

View File

@@ -1,8 +1,8 @@
# {{packageName}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

View File

@@ -1,8 +1,8 @@
# {{packageName}} - the PowerShell module for the {{appName}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
This PowerShell module is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

View File

@@ -1,8 +1,8 @@
# gPRC for {{packageName}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
## Overview
These files were generated by the [OpenAPI Generator](https://openapi-generator.tech) project.

View File

@@ -1,7 +1,7 @@
# {{{projectName}}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

View File

@@ -1,7 +1,7 @@
# {{{projectName}}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

View File

@@ -1,8 +1,8 @@
# R API client for {{packageName}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI spec](https://openapis.org) from a remote server, you can easily generate an API client.

View File

@@ -1,8 +1,8 @@
# Rust API for {{{packageName}}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
## Overview

View File

@@ -1,8 +1,8 @@
# Rust API client for {{{packageName}}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
## Overview

View File

@@ -6,7 +6,7 @@
- Build date: {{generatedDate}}
{{/hideGenerationTimestamp}}
{{#appDescription}}{{{appDescription}}}{{/appDescription}}
{{#appDescriptionWithNewLines}}{{{appDescriptionWithNewLines}}}{{/appDescriptionWithNewLines}}
{{#infoUrl}}
For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
@@ -104,4 +104,4 @@ Class | Method | HTTP request | Description
## Author
{{#apiInfo}}{{#apis}}{{^hasMore}}{{infoEmail}}
{{/hasMore}}{{/apis}}{{/apiInfo}}
{{/hasMore}}{{/apis}}{{/apiInfo}}

View File

@@ -2,10 +2,10 @@
{{appName}}
{{#appDescription}}
{{{appDescription}}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescription}}
{{/appDescriptionWithNewLines}}
# VERSION
Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
@@ -128,4 +128,4 @@ you just built.
## Author
{{#apiInfo}}{{#apis}}{{^hasMore}}{{infoEmail}}
{{/hasMore}}{{/apis}}{{/apiInfo}}
{{/hasMore}}{{/apis}}{{/apiInfo}}

View File

@@ -1,8 +1,8 @@
# Swift4 API client for {{{projectName}}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec from a remote server, you can easily generate an API client.

View File

@@ -1,8 +1,8 @@
# Swift5 API client for {{{projectName}}}
{{#appDescription}}
{{{appDescription}}}
{{/appDescription}}
{{#appDescriptionWithNewLines}}
{{{appDescriptionWithNewLines}}}
{{/appDescriptionWithNewLines}}
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec from a remote server, you can easily generate an API client.