Skip to content

fix(api-docs): indent multi-line Param descriptions + bump postman #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
roncodes merged 1 commit into from
May 27, 2026
Merged

fix(api-docs): indent multi-line Param descriptions + bump postman #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion scripts/generate-api-docs.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -914,7 +914,11 @@ function renderParam(field, indent) {

const lines = [head];
if (desc) {
lines.push(`${indent} ${escapeJsxText(desc)}`);
const escaped = escapeJsxText(desc);
const descLines = escaped.split('\n');
for (const dl of descLines) {
lines.push(dl.length ? `${indent} ${dl}` : '');
}
}

if (Array.isArray(nested) && nested.length > 0) {
Expand Down
2 changes: 1 addition & 1 deletion vendor/postman
Open in desktop
Submodule postman updated 35 files
+4 −0 postman/collections/Fleetbase API/Customers/.resources/definition.yaml
+79 −0 postman/collections/Fleetbase API/Customers/.resources/object.yaml
+57 −0 postman/collections/Fleetbase API/Customers/Create a Customer Order.params.yaml
+52 −0 postman/collections/Fleetbase API/Customers/Create a Customer Order.request.yaml
+43 −0 postman/collections/Fleetbase API/Customers/Create a Customer.params.yaml
+40 −0 postman/collections/Fleetbase API/Customers/Create a Customer.request.yaml
+6 −0 postman/collections/Fleetbase API/Customers/Forgot Customer Password.params.yaml
+13 −0 postman/collections/Fleetbase API/Customers/Forgot Customer Password.request.yaml
+18 −0 postman/collections/Fleetbase API/Customers/List Customer Orders.queryParams.yaml
+10 −0 postman/collections/Fleetbase API/Customers/List Customer Orders.request.yaml
+14 −0 postman/collections/Fleetbase API/Customers/List Customer Places.queryParams.yaml
+10 −0 postman/collections/Fleetbase API/Customers/List Customer Places.request.yaml
+10 −0 postman/collections/Fleetbase API/Customers/Login Customer.params.yaml
+25 −0 postman/collections/Fleetbase API/Customers/Login Customer.request.yaml
+10 −0 postman/collections/Fleetbase API/Customers/Logout All Customer Sessions.request.yaml
+10 −0 postman/collections/Fleetbase API/Customers/Logout Customer.request.yaml
+10 −0 postman/collections/Fleetbase API/Customers/Register Customer Device.params.yaml
+17 −0 postman/collections/Fleetbase API/Customers/Register Customer Device.request.yaml
+18 −0 postman/collections/Fleetbase API/Customers/Request Customer Creation Code.params.yaml
+17 −0 postman/collections/Fleetbase API/Customers/Request Customer Creation Code.request.yaml
+6 −0 postman/collections/Fleetbase API/Customers/Request Customer Login SMS.params.yaml
+13 −0 postman/collections/Fleetbase API/Customers/Request Customer Login SMS.request.yaml
+14 −0 postman/collections/Fleetbase API/Customers/Reset Customer Password.params.yaml
+15 −0 postman/collections/Fleetbase API/Customers/Reset Customer Password.request.yaml
+10 −0 postman/collections/Fleetbase API/Customers/Retrieve Authenticated Customer.request.yaml
+10 −0 postman/collections/Fleetbase API/Customers/Retrieve a Customer Order.request.yaml
+26 −0 postman/collections/Fleetbase API/Customers/Update Authenticated Customer.params.yaml
+18 −0 postman/collections/Fleetbase API/Customers/Update Authenticated Customer.request.yaml
+14 −0 postman/collections/Fleetbase API/Customers/Verify Customer Login Code.params.yaml
+27 −0 postman/collections/Fleetbase API/Customers/Verify Customer Login Code.request.yaml
+4 −0 postman/collections/Fleetbase API/Order Configs/.resources/definition.yaml
+66 −0 postman/collections/Fleetbase API/Order Configs/.resources/object.yaml
+18 −0 postman/collections/Fleetbase API/Order Configs/Query Order Configs.queryParams.yaml
+9 −0 postman/collections/Fleetbase API/Order Configs/Query Order Configs.request.yaml
+21 −0 postman/collections/Fleetbase API/Order Configs/Retrieve an Order Config.request.yaml