Adding multiple descriptive text for tags / summary:

Question

Hi, I am a newbie, so probably asking a stupid question.&nbsp;&nbsp;I am editing a YAML file that looks like this:&nbsp;paths:&nbsp; /api/login:&nbsp; &nbsp; post:&nbsp; &nbsp; &nbsp; summary: User login&nbsp; &nbsp; &nbsp; tags:&nbsp; &nbsp; &nbsp; &nbsp; - Authentication&nbsp; &nbsp; &nbsp; description: Use the credentials to log in.&nbsp; &nbsp; &nbsp; requestBody:&nbsp; &nbsp; &nbsp; &nbsp; description: Login credentials&lt;br/&gt;&nbsp; &nbsp; &nbsp; &nbsp; required: true&nbsp; &nbsp; &nbsp; &nbsp; content:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; application/json:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; schema:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; type: object&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; required:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; - username&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; - password&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; properties:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; username:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; type: string&nbsp;This displays something like this:Authentication&nbsp;User loginUse the credentials to log in.&nbsp;&nbsp;I want to add some text underneath Authentication, which describes the entire authentication process etc. (as well as keep the text already present underneath User Login for additional information)&nbsp; -&nbsp; I cannot work out how to do it? - Can anyone help a newbie?

ponelat · Answer

Hey&nbsp;benpo&nbsp;
&nbsp;
Not a silly question 🙂
I think the best avenue is to make use of Tag Descriptions, here are some docs around it&nbsp;https://swagger.io/docs/specification/2-0/grouping-operations-with-tags/
&nbsp;
Here is an example:&nbsp;https://app.swaggerhub.com/apis/SwaggerPMTests/tag-with-description/1.0.0#/Authentication

benpo · Answer

Thanks ponelat&nbsp;.Do I understand from the documentation that what I want to achieve is not possible?&nbsp;I want to put a description text under the Authentication tag heading. There is already description text there, which is displayed in the&nbsp; User Login section (which I also want) Ideally i would like to have an output like this:AuthenticationSome text about Authentication.&nbsp;User loginUse the credentials to log in.&nbsp;&nbsp;

ponelat · Answer

benpo&nbsp;I don't know what is generating that rendering, is it SwaggerUI or some other tool?&nbsp;
Did you look into the SwaggerHub example above?
&nbsp;

1. Tag&nbsp;
2. Tag Description
3. Operation (Method + Summary or Description)
4. External docs for Tag&nbsp;

benpo · Answer

I am rendering in Redoc.

Forum Discussion

Adding multiple descriptive text for tags / summary:

Authentication

User login

Authentication

User login

Related Content

Cycle Summary - Zephyr Squad

Dashboard Summary

Log.SaveResultsAs() Unable to export the summary

Test Execution Summary

$ref and description/title

Recent Discussions

Exploring Tax-saving Options: SBI Long Term Equity Fund vs. Parag Parikh Tax Saver Fund

Managing Multiple Auth Methods in Swagger UI

All application end points are displaying

exampleSetFlag additional property

Swagger UI rendering issues