docs: Add title for HTTP api docs#5228
Merged
alexeyzimarev merged 2 commits intorelease/oss-v22.10from Jul 29, 2025
Merged
Conversation
Member
|
@w1am can you set the dir order frontmatter for the HTTP API section to 99 so it shows last? |
Deploying eventstore with
|
| Latest commit: |
c595cf5
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://767da1de.eventstore.pages.dev |
| Branch Preview URL: | https://w1am-fix-v22-10-http-api.eventstore.pages.dev |
Contributor
Author
It was already set, but ignored because we are using a structured sidebar. The way the docs files were set up in the legacy docs is not compatible with what we configured in the documentation. The sidebar.cjs file in those legacy docs is ignored (but it's still useful for previewing the docs locally when running them in the same branch) So I kept the title, removed the order as well as some auto generated header in http api reference:
For legacy versions of the database, I will define the structure of the sidebar manually using this config: // The way these docs were setup in server v22.10 and v5 are not compatible with the new sidebar structure.
"/server/v22.10/": [
"introduction",
"installation",
"configuration",
"streams",
"indexes",
"projections",
"persistent-subscriptions",
"operations",
"diagnostics",
"networking",
"cluster",
"security",
"upgrade-guide",
"release-notes",
"release-schedule",
{
text: "HTTP API",
children: [
"http-api/introduction.md",
"http-api/security.md",
"http-api/persistent.md",
"http-api/projections.md",
"http-api/optional-http-headers.md",
"http-api/api.md"
],
collapsible: true,
}
],
"/server/v5/": [
"introduction",
"installation",
"configuration",
"security",
"networking",
"cluster",
"server-settings",
"admin-ui",
"indexes",
"projections",
"persistent-subscriptions",
"operations",
"diagnostics",
{
text: "HTTP API",
children: [
"http-api/introduction.md",
"http-api/security.md",
"http-api/persistent.md",
"http-api/projections.md",
"http-api/optional-http-headers.md",
"http-api/api.md"
],
collapsible: true,
}
], |
Member
|
Looks good |
alexeyzimarev
approved these changes
Jul 29, 2025
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.



Before
After