Document uuid_uri_variables.accept_any_identifier (api-components-bundle #567)
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Domain
- documentation
Research direction
Start in the API configuration reference under content/4.api/ and locate the section for silverback_api_components. Document uuid_uri_variables.accept_any_identifier as a list of FQCNs defaulting to [], with exact class matching and the provider requirements described in the issue. Done when the reference explains how these classes are merged with the bundle defaults and why a custom provider must return null for identifiers it cannot resolve.
Written by the indexing model from the issue text.
Description
api-components-bundle now has a config key for resources whose item identifier is not always a UUID (components-web-app/api-components-bundle#567, PR components-web-app/api-components-bundle#568).
Since 2.0.0-alpha.38 an item URL whose id is not a valid UUID is a 404 before any state provider runs, except for Route (by path), ComponentGroup (by reference) and Form (password_reset). A project with its own provider that resolves another identifier (e.g. a Page by reference at /_api/_/pages/share-resource-page) lists the class:
silverback_api_components:
uuid_uri_variables:
accept_any_identifier:
- Silverback\ApiComponentsBundle\Entity\Core\Page
To document (API configuration reference, content/4.api/):
- A list of FQCNs, default
[], merged with the bundle's three classes. - The operation's class is matched exactly; a subclass is not included.
- The class needs a provider that resolves the string and returns
nullfor one it cannot resolve; otherwise Doctrine's item provider returns a 500 for a string on a UUID column.
- Dominant language
- TypeScript
- Stars
- 0
- Forks
- 0
- Avg merge
- 1h 20m
- Merged PRs (30d)
- 1
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from components-web-app/docs
-
documentation
Difficulty 4/5 3-5 days Newbie friendliness 45/100
components-web-app/docs#290 · 2 comments ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
components-web-app/docs#289 · 2 comments ·
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 15/100
components-web-app/docs#237 · 2 comments ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
components-web-app/docs#1 · 3 comments ·
All issues in components-web-app/docs
Similar issues
-
area:cli bug P4
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
bug from-studio
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
esengine/DeepSeek-Reasonix#14868 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
linxiv-dev/linXiv#384 · 1 comment ·
Maintainers usually reply within 1 day
-
scope:core type:security
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
mailgun/mailgun.js#544 ·