feat(docs/ensnode.io): Add API Reference #1805
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| --- | ||
| --- | ||
|
|
||
| <nav class="scalar-toc"> | ||
| <h2 class="scalar-toc-heading">On this page</h2> | ||
| <ul class="scalar-toc-list"></ul> | ||
| </nav> | ||
|
|
||
| <script> | ||
| function buildToc() { | ||
| const list = document.querySelector('.scalar-toc-list'); | ||
| if (!list) return; | ||
|
|
||
| const headings = document.querySelectorAll('h2.section-header-label[id]'); | ||
| if (headings.length === 0) return false; | ||
|
|
||
| list.innerHTML = ''; | ||
| headings.forEach((h2) => { | ||
| const li = document.createElement('li'); | ||
| const a = document.createElement('a'); | ||
| a.href = `#${h2.id}`; | ||
| a.textContent = h2.textContent?.trim() ?? ''; | ||
| li.appendChild(a); | ||
|
|
||
| // Find h3s that belong to this h2's section | ||
| const section = h2.closest('.section'); | ||
| if (section) { | ||
| const h3s = section.querySelectorAll('h3[id]'); | ||
| if (h3s.length > 0) { | ||
| const subList = document.createElement('ul'); | ||
| subList.className = 'scalar-toc-sublist'; | ||
| h3s.forEach((h3) => { | ||
| const subLi = document.createElement('li'); | ||
| const subA = document.createElement('a'); | ||
| subA.href = `#${h3.id}`; | ||
| subA.textContent = h3.textContent?.trim() ?? ''; | ||
| subLi.appendChild(subA); | ||
| subList.appendChild(subLi); | ||
| }); | ||
| li.appendChild(subList); | ||
| } | ||
| } | ||
|
|
||
| list.appendChild(li); | ||
| }); | ||
|
|
||
| return true; | ||
| } | ||
|
|
||
| // Scalar renders async, so observe for headings to appear | ||
| if (!buildToc()) { | ||
| const observer = new MutationObserver(() => { | ||
| if (buildToc()) observer.disconnect(); | ||
| }); | ||
| observer.observe(document.body, { childList: true, subtree: true }); | ||
| } | ||
| </script> | ||
|
|
||
| <style> | ||
| .scalar-toc { | ||
| padding: 1rem 0; | ||
| } | ||
|
|
||
| .scalar-toc-heading { | ||
| color: var(--sl-color-white); | ||
| font-size: var(--sl-text-xs); | ||
| font-weight: 600; | ||
| text-transform: uppercase; | ||
| letter-spacing: 0.05em; | ||
| padding-bottom: 0.5rem; | ||
| } | ||
|
|
||
| .scalar-toc-list { | ||
| list-style: none; | ||
| padding: 0; | ||
| margin: 0; | ||
| border-inline-start: 1px solid var(--sl-color-hairline); | ||
| } | ||
|
|
||
| .scalar-toc-list li a { | ||
| display: block; | ||
| padding: 0.25rem 0 0.25rem 0.75rem; | ||
| color: var(--sl-color-gray-3); | ||
| font-size: var(--sl-text-xs); | ||
| text-decoration: none; | ||
| line-height: 1.5; | ||
| } | ||
|
|
||
| .scalar-toc-list li a:hover { | ||
| color: var(--sl-color-white); | ||
| } | ||
|
|
||
| .scalar-toc-sublist { | ||
| list-style: none; | ||
| padding: 0; | ||
| margin: 0; | ||
| } | ||
|
|
||
| .scalar-toc-sublist li a { | ||
| padding-inline-start: 1.5rem; | ||
| } | ||
| </style> |
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,13 @@ | ||
| --- | ||
| import Default from "@astrojs/starlight/components/TableOfContents.astro"; | ||
|
|
||
| import ScalarTableOfContents from "../molecules/ScalarTableOfContents.astro"; | ||
| import TelegramInvite from "../molecules/TelegramInvite.astro"; | ||
|
|
||
| const { starlightRoute } = Astro.locals; | ||
| const isApiReference = starlightRoute.slug === "ensapi/reference/api-reference"; | ||
| --- | ||
|
|
||
| {isApiReference ? <ScalarTableOfContents /> : <Default />} | ||
| <br /> | ||
| <TelegramInvite /> |
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
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,52 @@ | ||||||||||||||||||||
| --- | ||||||||||||||||||||
| title: ENSApi API Reference | ||||||||||||||||||||
| description: Interactive API reference documentation for ENSApi endpoints. | ||||||||||||||||||||
| sidebar: | ||||||||||||||||||||
| label: API Reference | ||||||||||||||||||||
| tableOfContents: | ||||||||||||||||||||
| minHeadingLevel: 6 | ||||||||||||||||||||
| maxHeadingLevel: 6 | ||||||||||||||||||||
| --- | ||||||||||||||||||||
notrab marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||||||||||
|
|
||||||||||||||||||||
| import { ScalarComponent } from "@scalar/astro"; | ||||||||||||||||||||
| import openapiSpec from "@workspace/docs/docs.ensnode.io/ensapi-openapi.json"; | ||||||||||||||||||||
|
|
||||||||||||||||||||
| <ScalarComponent | ||||||||||||||||||||
| configuration={{ | ||||||||||||||||||||
| content: openapiSpec, | ||||||||||||||||||||
|
Comment on lines
+12
to
+16
There was a problem hiding this comment. Importing the full OpenAPI JSON at build time will bundle the entire spec into the page’s JS payload. If Scalar supports loading from a URL or static asset path, consider switching to that approach to reduce client bundle size and improve initial load performance (especially as the spec grows).
Suggested change
Member
There was a problem hiding this comment. Doing so would (URL) mean we can't view in our preview deployments the upcoming API spec changes. Need to investigate the static asset path though... I assume this means just putting it in the
Collaborator
Author
There was a problem hiding this comment. i think not worth optimizing, is a-ok
Member
There was a problem hiding this comment. I looked to implement this last week but there is a lot more involved that would require changing the CI steps so we output the spec to the public directory. We could change the output directory of the generated spec (and what our CI check looks at), or copy on build to the I'm more inclined to follow option A to move the output directory to |
||||||||||||||||||||
| theme: "none", | ||||||||||||||||||||
| agent: { disabled: true }, | ||||||||||||||||||||
| hideDownloadButton: true, | ||||||||||||||||||||
| hiddenClients: true, | ||||||||||||||||||||
| telemetry: false, | ||||||||||||||||||||
| defaultOpenAllTags: true, | ||||||||||||||||||||
| expandAllResponses: true, | ||||||||||||||||||||
| hideClientButton: true, | ||||||||||||||||||||
| hideSearch: true, | ||||||||||||||||||||
| showOperationId: true, | ||||||||||||||||||||
| showSidebar: false, | ||||||||||||||||||||
| showDeveloperTools: "never", | ||||||||||||||||||||
| isEditable: false, | ||||||||||||||||||||
| isLoading: false, | ||||||||||||||||||||
| hideTestRequestButton: false, | ||||||||||||||||||||
| forceDarkModeState: "light", | ||||||||||||||||||||
| hideDarkModeToggle: true, | ||||||||||||||||||||
| withDefaultFonts: true, | ||||||||||||||||||||
| expandAllModelSections: true, | ||||||||||||||||||||
| customCss: ` | ||||||||||||||||||||
| .light-mode { | ||||||||||||||||||||
| --scalar-color-1: #121212; | ||||||||||||||||||||
| --scalar-color-2: rgba(0, 0, 0, 0.6); | ||||||||||||||||||||
| --scalar-color-3: rgba(0, 0, 0, 0.4); | ||||||||||||||||||||
| --scalar-color-accent: var(--color-primary); | ||||||||||||||||||||
| --scalar-background-1: var(--color-background); | ||||||||||||||||||||
| --scalar-background-2: #f6f5f4; | ||||||||||||||||||||
| --scalar-background-3: #f1ede9; | ||||||||||||||||||||
| --scalar-background-accent: color-mix(in srgb, var(--color-primary) 6%, transparent); | ||||||||||||||||||||
| --scalar-border-color: var(--color-border-light); | ||||||||||||||||||||
| } | ||||||||||||||||||||
| .scalar-mcp-layer { display: none !important; } | ||||||||||||||||||||
| .scalar-app .section { padding-inline: 0 !important; } | ||||||||||||||||||||
| `, | ||||||||||||||||||||
| }} | ||||||||||||||||||||
| /> | ||||||||||||||||||||
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR description mentions the API reference page uses
tableOfContents: false, but this frontmatter setstableOfContentsto an options object (min/max heading level 6). If the intent is to disable Starlight TOC for this page, set it explicitly tofalse; if the object form is intentional as a workaround, please align the PR description (or add a short comment here explaining why).