fetchResource loads actual items from the API due to wrong queryParameter
@soyuka y travaille déjà.
Depuis le 8/11/2024.
Évaluation
Cette issue n'a pas encore été évaluée.
Description
API Platform version(s) affected: 2.6.8
Description
The API doc parser uses fetch() via the fetchResource() method to load API metadata, and fails to apply the query parameter { itemsperpage: 0 } correctly to limit the request to only metadata and no API items.
fetchResource() tries to set the query parameter via a secondary options parameter, however fetch() doesn't support that - params have to be part of the url instead.
// Current code:
fetchJsonLd(
resourceUrl,
Object.assign({ itemsPerPage: 0 }, options)
)
// Fixed code:
fetchJsonLd(
resourceUrl + "?itemsPerPage=0",
options
)
How to reproduce
Possible Solution
Replace the Object.assign() call with an URL including the query parameter, possibly by building an URL:
const url = new URL(resource.url);
const params = new URLSearchParams(["itemsPerPage", 0]);
url.search = params.toString();
fetchJsonLd(url, options)
Additional Context
Please excuse that my code examples are in plain JS, not TS, since I'm not familiar enough with typescript.
- Langage dominant
- TypeScript
- Étoiles
- 113
- Forks
- 80
- Merge moyen
- 2 j 18 h
- PR mergées (30 j)
- 3
Préparer son environnement
Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de api-platform/api-doc-parser
-
Difficulté 3/5 1-2 jours Accessibilité débutants 35/100
api-platform/api-doc-parser#158 · 1 commentaire ·
-
Difficulté 4/5 3-5 jours Accessibilité débutants 35/100
api-platform/api-doc-parser#130 ·
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 20/100
api-platform/api-doc-parser#129 · 1 commentaire ·
-
Why aren't hydra and openapi3 generating the same componentsPeut-être à nouveau libre @J3m5 l’a pris il y a 485 jours, et aucune pull request n’est ouverte. Ouverte
api-platform/api-doc-parser#125 · 1 commentaire · 1 personne assignée ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 42/100
api-platform/api-doc-parser#113 ·
Toutes les issues de api-platform/api-doc-parser
Issues similaires
-
cleanName keeps a state code that's joined to the word before it (SavannahGa → "Savannah Ga")Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
openwatersio/slackwater-database#281 ·
Les mainteneurs répondent en général sous 1 jour
-
accepted bug via-triage
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
pingdotgg/t3code#18690 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
Bayern feature:Application ready web
Difficulté 2/5 1-3 heures Accessibilité débutants 67/100
digitalfabrik/entitlementcard#3176 ·
Les mainteneurs répondent en général sous 7 jours
-
[BUG] 运行位置的分支列表不自动刷新，外部新建的分支看不到Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
NanmiCoder/cc-haha#1533 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
Les mainteneurs répondent en général sous 1 jour