Allow custom constraints on UUID resource routes generated by jsonapi_resources#662
Merged
lgebhardt merged 1 commit intoJSONAPI-Resources:masterfrom Apr 29, 2016
Conversation
Contributor
|
@davidstosik Thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What?
At the moment, the routing method
jsonapi_resourcescompletely overridesoptions[:constraints]if the resource'sresource_key_typeis:uuid.This makes it impossible to define advanced custom constraints that would apply
to those routes, be them related to the
:idparam or not.How?
I'm suggesting here to set
options[:constraints][:id]in the only case thatno custom constraint was specified on
:id. This allows to set a customconstraint on
:id(see below why), as well as others (such as:ip).Why?
My personal reason to request this feature is to allow myself a way to define
shortcut API endpoints such as
/api/users/me, wheremewill stand for thecurrent user's UUID. This is actually already possible when ids are numeric
(because
options[:constraints]is not overridden).Example