With sub-resource support useless resource came to our documentation. We have resources where we do need a root resource just for having its sub-resources and to use it as a sub-resource as well.
The suggestion is to add parameters "resourceExcludesFile" and "resourceIncludeFile". These files should contain list ("EOF" separated) of relative resource URLs. These URLs should be excluded if they are in the "resourceExcludesFile" file. Otherwise, using "resourceIncludesFile" file we can list concrete resources we would like to expose in the documentation ("resourceExcludesFile" file should be simply ignored).
Let's say we have "comments" and "posts" resources. And we would like to expose a sub-resource of "comments", e.g. "types", so we need "comments" as a root resource, but "/comments" resource itself is not useful. In that case we would have an exclude list file with a single entry:
With sub-resource support useless resource came to our documentation. We have resources where we do need a root resource just for having its sub-resources and to use it as a sub-resource as well. The suggestion is to add parameters "resourceExcludesFile" and "resourceIncludeFile". These files should contain list ("EOF" separated) of relative resource URLs. These URLs should be excluded if they are in the "resourceExcludesFile" file. Otherwise, using "resourceIncludesFile" file we can list concrete resources we would like to expose in the documentation ("resourceExcludesFile" file should be simply ignored).
Let's say we have "comments" and "posts" resources. And we would like to expose a sub-resource of "comments", e.g. "types", so we need "comments" as a root resource, but "/comments" resource itself is not useful. In that case we would have an exclude list file with a single entry:
Any thoughts are welcome!