Repository navigation
Show what each released RESTest found on the Web Fuzzing Dataset's APIs - #5
Merged
Merged
Conversation
…Is, on /showcase and in a band of the first page scripts/sync-showcase.mjs reads the campaigns isa-group/restest-dataset publishes as releases, the newest version first, and writes what the showcase and the band show; the newest campaign's report.html files are served by the site, an older one's rows link to its release. /showcase/ is the newest campaign's table, each older one is at /showcase/<version>/, and the first page's band "On real APIs" shows its figures and the APIs with the most errors. With no campaign published there is no showcase, no link to it and no band. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…showcase lead that holds for any campaign, a shorter foot, and no licence link The first band starts from an API schema rather than a document; the band "On real APIs" shows its link to the Web Fuzzing Dataset as one; the showcase's lead links the dataset and names neither every API nor a version, which the line under the table gives; that line is the campaign's alone; and the foot of the site says Apache 2.0 without a link. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…d styles, and downloads a few at a time What the reviews of the change found: the showcase's address is one value the layout, the documentation's header and the band read; the layout finds its page's own address; the band is a component of its own, its styles beside the first page's other figures; the showcase reuses the first page's kicker, arrow links and link style; a row's report is a plain address; errors name where they are, as the documentation's do; the reader of a campaign in a folder is the library's, which the tests use; the build stops if a band is missing from the first page's list; and a campaign's files are fetched six at a time. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… put first whatever the order given, and failures named Each campaign is at /showcase/<version>/, the newest at /showcase/ too, as planned; an API may not be called "index". buildShowcase puts the campaigns newest first and empties the folder of served reports itself, which the tests now show; an unreadable report, an older campaign's page its release lacks, a manifest that is not JSON and a listing that is not JSON stop the build naming where; a download is kept under its name only once whole; why an API was not tested is shown, not only on hover; and the README and the workflow say where the showcase comes from. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
ssegura
force-pushed
the
feat/showcase
branch
from
November 10, 2026 19:14
0e4e86f to
b1d07ff
Compare
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.
Related: #4, the first page, which this builds on and which is merged first. The campaigns are the releases of isa-group/restest-dataset, made by its workflow
showcase.yml. This pull request is merged once 2.5.0's campaign is published, after its build here has been run again, which then downloads a published campaign for the first time.What you can do now that you could not before
Anyone on the site can see what each released RESTest found on the REST APIs of the Web Fuzzing Dataset:
/showcase/shows the newest campaign as a table, each API with its figures, its operations by what was found and itsreport.htmlone click away, every campaign keeps its own address at/showcase/<version>/, and the first page sums the newest campaign up in a band, "On real APIs". Until a campaign is published, as today, the site shows none of it.Try it yourself
With Node 26, from a clean clone:
No campaign is published yet, so the site is as it was: no showcase, no link to it, no band. To see them, build from the trial campaign of 2.4.0, kept as a draft for this (seeing a draft needs write access to the dataset), with the documentation on RESTest's
master, whose first page has every band:Then open http://localhost:4321/restest-site/ (the band is the third) and http://localhost:4321/restest-site/showcase/.
How it works
Before each build,
scripts/sync-showcase.mjslists the dataset's releases taggedshowcase-v<version>, published and not drafts or prereleases, puts them newest version first, reads each campaign'smanifest.jsonand every API'sreport.json, and writes insrc/generated/showcase.jsonwhat the pages show: each API's figures, its operations counted once each (with an error, else with only warnings, else tested with nothing found, else not tested), and each campaign's five figures. The newest campaign'sreport.htmlfiles are copied into the site, to be opened there; an older campaign's rows link to theirs in its release, to be downloaded. The build stops, naming the release and the file, on a manifest of another format or version, a file the manifest names and the release lacks, or a report it cannot read.The page and the band are the approved mock-up's, on the site's tokens: the campaign picker (a list of links that opens without the script), the filter (only with it), the legend, the figures and the table; on a phone the table keeps the API, its errors, the bar and the report, and the bar is said in words for screen readers. The showcase keeps its own choice of light or dark, and its own canonical address.
What changed in the code
scripts/lib/showcase.mjs, new: which releases are campaigns and in what order, the manifest's checks (format, version, API ids that can be part of a path, never "index"), an API's row, a campaign's figures and its five APIs with most errors, andbuildShowcase(), which reads a campaign's files together and copies the newest's reports.localCampaign()reads a campaign from a folder, for--fromand the tests.scripts/sync-showcase.mjs, new: the listing of releases (the token, when set, sent to GitHub's API alone), downloads tried three times, six at once, kept in.restest/showcase/under each asset's id and only once whole, and--from <folder>, which can be repeated.scripts/lib/files.mjs:write(), whichsync-docs.mjsnow imports too.scripts/lib/landing-run.mjs:minutes()exported and reading seconds;run.ts'sminutesInWordssays hours and seconds.src/pages/showcase/[...campaign].astro,src/components/showcase/data.tsandShowcaseBand.astro, new;src/pages/index.astroplaces the band, numbering the bands and alternating their backgrounds from one list, and stops the build if a band is missing from it;src/layouts/Landing.astrofinds its page's own canonical address and takes a theme key;src/components/landing/links.tsandformat.tshold the links to the documentation, the showcase's included, and the number format both pages use;src/components/SocialIcons.astroadds "Showcase" to the documentation's header.src/styles/showcase.css, new;landing.cssgains the band's styles beside the black box's figures, sharing their colours, and what the band's table and the showcase's share..github/workflows/site.yml: both builds read the showcase, in a step of its own, the only one givenGITHUB_TOKEN.README.md: the showcase, how to preview a campaign not published, how the site is rebuilt once one is, and how an API is removed at its author's request.test/showcase.test.mjs, new, 11 tests.Evidence
dist/85 MB of which 68 MB are reports, in about 2 seconds of build; Pagefind indexes the 76 pages of the documentation only. Checked in a browser, light and dark, at 1280 and 375 pixels wide (no sideways scroll), with the filter, the report links and the documentation's link; the grey of "not tested" stands at 5.2:1 or more against its background in both themes. Without a campaign, 74 pages, no showcase, no link, no band.Decisions taken
showcase.jsonis read as no campaign, so that a build of the documentation alone still builds.Open questions
None.
feat/landing-page(The first page: what RESTest is and how to start, with a real run, for humans and for agents #4), andmainonce The first page: what RESTest is and how to start, with a real run, for humans and for agents #4 is merged🤖 Generated with Claude Code