Swagger Plugin Does Not Fully Support the External Documentation Object | Community
Skip to main content
Level 4
March 27, 2024
Solved

Swagger Plugin Does Not Fully Support the External Documentation Object

  • March 27, 2024
  • 2 replies
  • 785 views

If Swagger content is using the External Documentation Object, the HTML formatting isn’t correct in AEM Sites:

Swagger Version : 2.0

Example Codeblock in the Guides concpet : 

 

{
"openapi": "3.0.1",
"servers": [
{
"url": "https:google.com",
"description": "Generated server url"
}
],
"tags": [
{
"name": "Search",
"description": "Search Here.",
"externalDocs": {
"description": "Click here to search.",
"url": "google.com"
}
}]

}

 

 

This post is no longer active and is closed to new replies. Need help? Start a new post to ask your question.
Best answer by kautuk_sahni

@beaula123 Did you find the suggestion helpful? Please let us know if you require more information. Otherwise, please mark the answer as correct for posterity. If you've discovered a solution yourself, we would appreciate it if you could share it with the community. Thank you!

2 replies

TarunKumar
Community Advisor
Community Advisor
April 22, 2024

HI @beaula123 ,

You can use open API swagger specification to integrate a restful webservicewith adaptive form. In the POST specification of swagger yaml or json file you can put "consume", "produces" and "parameter" field. And in GET item you can mention how you want your response by giving "produces" and "consumes" value as "application/json" or "text/plain; charset=utf-8".


Thanks
Tarun

kautuk_sahni
Community Manager
kautuk_sahniCommunity ManagerAccepted solution
Community Manager
June 10, 2024

@beaula123 Did you find the suggestion helpful? Please let us know if you require more information. Otherwise, please mark the answer as correct for posterity. If you've discovered a solution yourself, we would appreciate it if you could share it with the community. Thank you!

Kautuk Sahni
Beaula123Author
Level 4
June 12, 2024

We fixed the issue by customizing the css.

 

Thanks