This page edits the icons that periwinkle puts in front of the groups in a generated API reference's sidebar.
Those groups come from the tags of your OpenAPI document. A tag named
Shops becomes a sidebar group "Shops", and periwinkle looks up that name in
the list below to decide which icon it gets. So the keys on the left are not free text:
each one is a tag name you expect to see in an API contract, and the icon next to it is
what that group will show.
The list that ships with periwinkle covers common API vocabulary, but your contract is yours: add every tag you actually use, remove what you never will, and repoint any icon that does not fit your domain. Building your own list this way is the point of this page, and it means no group in your reference falls back to the generic default unless you want it to.
Matching ignores case and treats _, - and / as
spaces, so Rate_Limits, rate-limits and
Rate limits all find the same entry. Singular and plural also find each
other: one entry for invoices covers a tag named Invoice too.
Both forms are only listed separately where the icon set has a genuine plural
counterpart, as with user (one avatar) and users (two).
A tag that matches nothing keeps the default icon shown below, so nothing ever renders
without one.
Every icon exists in two styles. Click either column to pick that style for the row, or
click the row itself to keep the style it already uses. When you are done, download the
JSON and save it over
src/render/section-icons.json in your periwinkle checkout. Nothing leaves
your browser.
Default icon for unmatched titles:
| Section title | Bulk | TwoTone |
|---|