Unable to add Description for Resources

stoicflame / enunciate

Build-time enhancement tool for Java-based Web services projects

http://enunciate.webcohesion.com/

Other

480 stars 200 forks source link

Unable to add Description for Resources #1203

Closed NoelToy closed 4 weeks ago

NoelToy commented 3 months ago

am using Enunciate 2.14.0 on SpringBoot Rest API project. The issue is that I am not able to add description to any of the resources. I am using Enunciate Docs module to generate the API document. @stoicflame can you please help me out with this? Is the feature of providing description for resources is available in Enunciate? If yes can I know how? Because I wasn't able to find any documentation on it.

NB: Am attaching some images for reference.

IMG_20240327_103543~2.jpg

stoicflame commented 3 months ago

Can you please try "grouping" the resources by "class" and see if that gives you what you need?

<enunciate>
  <modules>
    <spring-web groupBy="class"/>

NoelToy commented 3 months ago

Hi @stoicflame thanks for the reply, but I have added yet in the documentation it's not reflecting. It would be so helpful is you could help me figure out this.

NB: For reference I am attaching the image of properties. IMG_20240329_065357~2.jpg

stoicflame commented 3 months ago

I'm afraid I can't reproduce your problem. Documentation at the resource level is captured fine in all my testing environments and applications.

The only way I can see forward to help you is if you can provide an example project that manifests the problem.

NoelToy commented 3 months ago

Sure I can give you a base implementation for the project. But even before that could you please share an example of how the description is give for each api in Enunciate? If you can share an example it would be grateful as I can find out where am going wrong.

stoicflame commented 3 months ago

You can always check out the enunciate-sample app.

stoicflame commented 4 weeks ago

Closing for now; happy to reopen as needed.