Does Apigee Developer Portal smartdocs supports rendering of "summary" field from Open API Spec / Swagger ?

I see only description field value getting displayed in listing & overview page. Summary field value from OpenAPI Spec / Swagger spec is not captured / displayed anywhere in developer portal.

Is it by design ? Any plans to support same moving forward ?

Solved Solved
1 6 536
1 ACCEPTED SOLUTION

Unfortunately, As of today, it doesn't support. We might support in future sending additional data to smartdocs from spec.

View solution in original post

6 REPLIES 6

Unfortunately, As of today, it doesn't support. We might support in future sending additional data to smartdocs from spec.

@Anil Sagar . Is this feature planned to be supported in near future release.

@Apoorva Gupta , Looks like team might not be adding new features to the smartdocs. @Marsh Gardiner Can you please confirm same ?

If I remember correctly, the summary is not used if the description is present. Most often, the summary is a shorter form version of the description, so we prefer the description if both are available.

We're not making substantive changes to SmartDocs v1 at this time.

@Marsh Gardiner. the issue we are facing is with the formatting. We have html tags in description which are not supported in summary(that comes on the page with all operation) but the description comes fine if we open individual operation. Is there any way to fix it.

summary-without-format.png

description-with-format.png

is there a smartdocs v2 version? does it support this feature (and/or rendering of request and response bodies *BEFORE* you make the call)?