Fix REST API GET when markdown document is given as the description.

[Arshardh]

Current Limitation

API descriptions saved as markdown are stored as documents. When product APIs are used to fetch API metadata, the description text is returned as null.
This means it needs a minimum of three API calls to get the API description through the product APIs. This makes it very inefficient to fetch the API descriptions.

Suggested Improvement

We will have to modify the REST API and solve this limitation

Version

No response

[hisanhunais]

aqeel will work on this

[AqeelMuhammad]

Progress Update - 2025/01/17

• In the Publisher Portal, created two APIs with two different description types; Text and Markdown.
• Inspected the APIs called while updating the description and viewing the basic info of the APIs.
• Imported the postman collection and checked the following resources in the debug mode.
  1. /apis/{{apiId}}
  2. /apis/{{apiId}}/documents
  3. /apis/{{apiId}}/documents/{{documentId}}
  4. /apis/{{apiId}}/documents/{{documentId}}/content