awslabs / aws-api-gateway-developer-portal

A Serverless Developer Portal for easily publishing and cataloging APIs
Apache License 2.0
932 stars 402 forks source link

Serverless Developer portal doesn't show Apigateway API part documentation fully as a description #592

Open JukkaTim opened 2 years ago

JukkaTim commented 2 years ago

We have quite large Swagger file which we imported as a new Rest Api to AWS Api Gateway. File includes comprehensive documentation in Markdown markup language which shows up in Api Gateway API Part. When Api is published to Developer Portal it only shows the first line as a Api's description. It breaks where is first Markdown line feed.

I asked that from AWS support and they could reproduce this problem.

As a workaround I wrote one short sentence to the description part. In that I included Url to our external documentation page where real long General part of Api documentation can be seen with images and code examples. It would be nice if Developer portal could show all documentation written on Api Gateway API part. Or at least show a link to external documentation page.