fetchResource loads actual items from the API due to wrong queryParameter
@soyuka arbeitet bereits daran.
Seit 08.11.2024.
Bewertung
Dieses Issue wurde noch nicht bewertet.
Beschreibung
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.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 113
- Forks
- 80
- Ø Merge
- 2 T. 18 Std.
- Gemergte PRs (30 T.)
- 3
Entwicklungsumgebung
Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus api-platform/api-doc-parser
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 35/100
api-platform/api-doc-parser#158 · 1 Kommentar ·
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100
api-platform/api-doc-parser#130 ·
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 20/100
api-platform/api-doc-parser#129 · 1 Kommentar ·
-
Why aren't hydra and openapi3 generating the same componentsEvtl. wieder frei @J3m5 hat das vor 483 Tagen übernommen, und es ist kein Pull Request offen. Offen
api-platform/api-doc-parser#125 · 1 Kommentar · 1 zugewiesene Person ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 42/100
api-platform/api-doc-parser#113 ·
Alle Issues in api-platform/api-doc-parser
Ähnliche Issues
-
Table: Space fires onActivate in single-selection mode — the reference doc and the JSDoc disagreeOffen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
sidorares/react-x11-components#764 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
backnotprop/plannotator#1840 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
JoviDeCroock/pracht#432 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Add: CNN en Espanol SDOffenapproved check:passed streams:add
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 75/100
Maintainer antworten meist innerhalb von 1 Tag
-
Hardware attribute name "app Connection Support" has inconsistent casingEvtl. vergeben Ein verknüpfter Pull Request ist offen oder bereits gemergt. Offen
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 88/100
walletbeat/walletbeat#1628 ·
Maintainer antworten meist innerhalb von 1 Tag