rakutentech
Layout adjustment - PHPdocs and Tags
Hi @kevincobain2000, I am making a layout change to meet a need in my project and I would like to know your opinion on submitting this PR for the project or do you think it is not necessary. My main problem was not having the option to display description and example for the fields of both BODY PARAMETERS and QUERY PARAMETERS. After displaying these values, the layout became very confusing so I made an adjustment that ended up changing the screen the way it was. The rules are no longer displayed each on a line, but rather all on a single line, and below we have a collapse to display the descriptions and examples. Below is a print of how it turned out. Note. I didn't really like the idea of collapse, but it was what I could think of to display the description and example and not clutter the screen, if you have any suggestions I would be very grateful.
Any suggestion is welcome.
Thank's for your time
Let me understand this correctly, where does the description come from? I don't think LRD has a way to parse the description per rule.
In my rush I ended up not describing the entire solution. I am adjusting the LDR to precisely present the description/example of the fields. This information will come from a method in the formRequest that was created for this purpose, it would be something similar to the idea used in another documenter Scribe. So, this way we can enrich the documentation of the fields. And I'm also making a change to add a description to the methods through the comments using PHPDoc as a reference to extract the summary and description as defined phpDoc, so we will also have a description of the method. And finally, I'm looking in the controller's doc block for a @package tag, to have the option of grouping the routes by this value, which could be a more user friendly value, so instead of displaying the route as a grouper, I would display this value from the package. which could be a prettier name. And the other detail is that I'm making all these adjustments reflect in the generation of OpenAPI data, so with the import of this data into Postman, Insominia, these values will already be available. I hope I was able to explain, my English is bad so I'm using a translator, sorry if it seems rude in the comments.
obs. I had used the wrong username at the time of posting.
This feature has been requested in the past as well, but no one submitted a PR.
I have welcomed such in the past to obtain extra information from phpdocs and @package tags etc.
Will look into a PR if submitted.
Thanks