Skip to content
This repository has been archived by the owner on Nov 11, 2017. It is now read-only.

Resources includes/excludes list #62

Open
bleshik opened this issue Jan 15, 2014 · 0 comments
Open

Resources includes/excludes list #62

bleshik opened this issue Jan 15, 2014 · 0 comments

Comments

@bleshik
Copy link
Contributor

bleshik commented Jan 15, 2014

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:

GET /comments

Any thoughts are welcome!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant