search

OpenAPITools / openapi-generator

OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)
https://openapi-generator.tech
Apache License 2.0
21.98k stars 6.6k forks source link

Enhancement: Proper linting of Markdown documentation generated for client SDKs #2441

Open theWhiteWulfy opened 5 years ago

theWhiteWulfy commented 5 years ago
Description

The markdown documentation generated for clients are not properly linted and cause problems with markdown based documentation generators i.e. docusaurus or docsify

openapi-generator version

4.0.0-beta2

Steps to reproduce

The issue could be reproduced by selectively generating Client SDK docs and using it inside a docs folder inside a Docsify/Docusaurus installation.

Related issues/PRs

None found. But a similar open issue exists in swagger-codegen.

Suggest a fix/enhancement

I've fixed the linting problems on Android, C#, Java, JavaScript, Go, Ruby-client, python and PHP

wing328 commented 5 years ago

@Oxyenyos thanks for reporting the issue. Do you mind filing a PR with the fix?

theWhiteWulfy commented 5 years ago

I did a PR #2458 that corrects the issues on Android, C#, Java, JavaScript, Go, Ruby-client, python and PHP clients. If you want I could do the same for each documentation template.