JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources
Public key
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 2.3k
- Forks
- 546
- PR merge metrics
- No merged PRs in 30d
Description
Have the ability to have a public key, which is used by the resources with the underlying model using a different primary key. For example internally the models use integer primary keys and externally the resources use uuids.
Initially this project was trying to make the primary_key option perform both roles, which was problematic. I think it might be possible however to make this feature work with a public_key option on a Resource.
This has been requested several times, and recently #427 brought this up again.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing how Resource currently handles primary keys and the related discussion in issue #427. Define the intended separation between an internal model primary key and a Resource public key, including how UUIDs are exposed and resolved; the feature is done when that behavior is specified and covered for the requested use case.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rails, ruby
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100