Skip to content

Adding additional classes for parsing #33673

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
davidejones merged 4 commits into from
Jan 7, 2026
Merged

Adding additional classes for parsing #33673

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
217f4e6
add data-parent-field
davidejones Jan 6, 2026
fd6bfbd
add table-cell, table-row
davidejones Jan 6, 2026
d338e0e
fix tests
davidejones Jan 6, 2026
9e811c9
update examples
davidejones Jan 6, 2026
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
15 changes: 10 additions & 5 deletions assets/scripts/build-api-pages.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ const oneOfLimit = 50;

const supportedLangs = ['en'];

// Create a renderer once so we don't recreate it on every call set paragraph tag to table-cell
const renderer = new marked.Renderer();
renderer.paragraph = (text) => `<p class="table-cell">${text}</p>`;

/**
* Update the menu yaml file with api
* @param {object} apiYaml - object with data
Expand Down Expand Up @@ -665,7 +669,7 @@ const fieldColumn = (key, value, toggleMarkup, requiredMarkup, parentKey = '') =
}
return `
<div class="col-4 column">
<p class="key">${toggleMarkup}${field}${requiredMarkup}</p>
<p class="key table-cell">${toggleMarkup}${field}${requiredMarkup}</p>
</div>
`.trim();
};
Expand Down Expand Up @@ -699,10 +703,10 @@ const typeColumn = (key, value, readOnlyMarkup) => {
typeVal = (value.format || value.type || '');
}
if(value.type === 'array') {
return `<div class="col-2 column"><p>[${(value.items === '[Circular]') ? 'object' : (value.items.type || '')}${oneOfLabel}]${readOnlyMarkup}</p></div>`;
return `<div class="col-2 column"><p class="table-cell">[${(value.items === '[Circular]') ? 'object' : (value.items.type || '')}${oneOfLabel}]${readOnlyMarkup}</p></div>`;
} else {
// return `<div class="col-2"><p>${validKeys.includes(key) ? value : (value.enum ? 'enum' : (value.format || value.type || ''))}${readOnlyMarkup}</p></div>`;
return `<div class="col-2 column"><p>${typeVal}${oneOfLabel}${readOnlyMarkup}</p></div>`.trim();
return `<div class="col-2 column"><p class="table-cell">${typeVal}${oneOfLabel}${readOnlyMarkup}</p></div>`.trim();
}
};

Expand All @@ -727,8 +731,9 @@ const descColumn = (key, value) => {
if(value.deprecated) {
desc = `**DEPRECATED**: ${desc}`;
}
const descHtml = desc ? marked.parse(desc, { renderer }).trim() : "";
const def = (value.default) ? `<p>default: <code>${value.default}</code></p>` : '';
return `<div class="col-6 column">${marked(desc) ? marked(desc).trim() : ""}${def}</div>`.trim();
return `<div class="col-6 column">${descHtml}${def}</div>`.trim();
};


Expand Down Expand Up @@ -846,7 +851,7 @@ const rowRecursive = (tableType, data, isNested, requiredFields=[], level = 0, p
html += `
<div class="row ${outerRowClasses}">
<div class="col-12 first-column">
<div class="row ${nestedRowClasses}">
<div ${parentKey ? `data-parent-field="${parentKey}"` : ""} class="row table-row ${nestedRowClasses}">
${fieldColumn(key, value, toggleArrow, required, parentKey)}
${typeColumn(key, value, readOnlyField)}
${descColumn(key, value)}
Expand Down
6 changes: 3 additions & 3 deletions assets/scripts/tests/build-api-pages.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2489,7 +2489,7 @@ describe(`fieldColumn`, () => {

const emptyResult = `
<div class="col-4 column">
<p class="key"></p>
<p class="key table-cell"></p>
</div>
`.trim();

Expand All @@ -2507,7 +2507,7 @@ describe(`typeColumn`, () => {
it('should show type value', () => {
const obj = {description: ""};
const actual = bp.typeColumn("type", "array", "");
const expected = `<div class="col-2 column"><p>array</p></div>`;
const expected = `<div class="col-2 column"><p class="table-cell">array</p></div>`;
expect(actual).toEqual(expected);
});

Expand Down Expand Up @@ -2538,7 +2538,7 @@ describe(`descColumn`, () => {
const obj = "TODO";
const key = "description";
const actual = bp.descColumn(key, obj);
const expected = '<div class="col-6 column"><p>TODO</p></div>';
const expected = '<div class="col-6 column"><p class="table-cell">TODO</p></div>';
expect(actual).toEqual(expected);
});

Expand Down
6 changes: 3 additions & 3 deletions content/en/api/v1/authentication/examples.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,23 @@
"json": {
"valid": true
},
"html": "<div class=\"\"><div class=\"row isReadOnly\">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row isReadOnly\">\n <div class=\"col-4 column\">\n <p class=\"key\">valid</p>\n </div>\n <div class=\"col-2 column\"><p>boolean</p></div>\n <div class=\"col-6 column\"><p>Return <code>true</code> if the authentication response is valid.</p></div>\n </div>\n \n </div>\n </div></div>"
"html": "<div class=\"\"><div class=\"row isReadOnly\">\n <div class=\"col-12 first-column\">\n <div class=\"row table-row first-row isReadOnly\">\n <div class=\"col-4 column\">\n <p class=\"key table-cell\">valid</p>\n </div>\n <div class=\"col-2 column\"><p class=\"table-cell\">boolean</p></div>\n <div class=\"col-6 column\"><p class=\"table-cell\">Return <code>true</code> if the authentication response is valid.</p></div>\n </div>\n \n </div>\n </div></div>"
},
"403": {
"json": {
"errors": [
"Bad Request"
]
},
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors&nbsp;[<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>Array of errors returned by the API.</p></div>\n </div>\n \n </div>\n </div></div>"
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row table-row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key table-cell\">errors&nbsp;[<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p class=\"table-cell\">[string]</p></div>\n <div class=\"col-6 column\"><p class=\"table-cell\">Array of errors returned by the API.</p></div>\n </div>\n \n </div>\n </div></div>"
},
"429": {
"json": {
"errors": [
"Bad Request"
]
},
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors&nbsp;[<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>Array of errors returned by the API.</p></div>\n </div>\n \n </div>\n </div></div>"
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row table-row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key table-cell\">errors&nbsp;[<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p class=\"table-cell\">[string]</p></div>\n <div class=\"col-6 column\"><p class=\"table-cell\">Array of errors returned by the API.</p></div>\n </div>\n \n </div>\n </div></div>"
}
},
"request": {
Expand Down
108 changes: 54 additions & 54 deletions content/en/api/v1/aws-integration/examples.json
View file
Open in desktop

Large diffs are not rendered by default.

Loading
Loading