Skip to content

docs: Add title for HTTP api docs#5228

Merged
alexeyzimarev merged 2 commits intorelease/oss-v22.10from
w1am/fix-v22.10-http-api
Jul 29, 2025
Merged

docs: Add title for HTTP api docs#5228
alexeyzimarev merged 2 commits intorelease/oss-v22.10from
w1am/fix-v22.10-http-api

Conversation

@w1am
Copy link
Copy Markdown
Contributor

@w1am w1am commented Jul 28, 2025

Before

{1D848F2B-3E5E-4307-8933-9F3256494C9A}

After

{19C58EDB-EA9C-4993-BB45-937C0C41742C}

@alexeyzimarev
Copy link
Copy Markdown
Member

@w1am can you set the dir order frontmatter for the HTTP API section to 99 so it shows last?

@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying eventstore with  Cloudflare Pages  Cloudflare Pages

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

View logs

@w1am
Copy link
Copy Markdown
Contributor Author

w1am commented Jul 28, 2025

@w1am can you set the dir order frontmatter for the HTTP API section to 99 so it shows last?

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:

{767B8043-4385-40D6-9A36-CA452C621EBB}

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,
      }
    ],

Before:
{86067F64-787B-497F-A3C4-B7179F20E8BD}

After:
{5D819B25-0387-421D-9EFA-C507525CBFE9}

Copy link
Copy Markdown
Member

Looks good

@alexeyzimarev alexeyzimarev merged commit 9fcc6ed into release/oss-v22.10 Jul 29, 2025
1 check passed
@alexeyzimarev alexeyzimarev deleted the w1am/fix-v22.10-http-api branch July 29, 2025 10:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants