Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rejecting submission of XML when usage of reserved names #33

Open
ghost opened this issue Oct 20, 2015 · 0 comments
Open

Rejecting submission of XML when usage of reserved names #33

ghost opened this issue Oct 20, 2015 · 0 comments

Comments

@ghost
Copy link

ghost commented Oct 20, 2015

"trending", "new", "popular", and "updated" should be reserved names, and should be rejected when provided as plugin key in the XML file of any plugin.

This is because, the fact of having those reserved names could lead to some conflicts, like :

/api/plugin/room => card of a single plugin
/api/plugin/trending => list of all trending plugins
/api/plugin/new => list of all recently added plugins
/api/plugin/popular => list of all popular plugins
/api/plugin/updated => list of all recently updated plugins

but what if we have new as a plugin key,
the url for the plugin at the API level would be : /api/plugin/new
which is in conflict with the endpoint that lists all the recently added plugins.

In fact, this conflicts is not that much of a problem for the Slim Framework's Router,
because the "list of new plugins" endpoint is registered on the router before the
"single plugin" endpoint, so this, won't break the homepage;
but the plugin will still be unavailable for direct query of it's card.

ghost pushed a commit that referenced this issue Oct 20, 2015
 + popped issue #33 while thinking
 + being more clear about the paginated nature of some endpoints
 + providing x-range in headers
 + providing parameters in each endpoint infos
 + summary for each endpoints
 + all endpoints covered
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

0 participants