From f57cfb2724d6bd2957b27657a906453274f2bc00 Mon Sep 17 00:00:00 2001 From: Aramis Date: Mon, 11 Dec 2023 09:40:16 -0500 Subject: [PATCH] add other docs to the sidebar as well Signed-off-by: Aramis --- docs/openapi/generate-client.md | 6 ++++++ docs/openapi/test-case-validation.md | 6 ++++++ microsite/sidebars.json | 4 +++- 3 files changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/openapi/generate-client.md b/docs/openapi/generate-client.md index 10e6ec3b2f..4afa7d64d7 100644 --- a/docs/openapi/generate-client.md +++ b/docs/openapi/generate-client.md @@ -1,3 +1,9 @@ +--- +id: generate-client +title: Generate a client from your OpenAPI spec +description: Documentation on how to create a client for a given OpenAPI spec +--- + ## How to generate a client with `repo-tools schema openapi generate-client`? ### Prerequisites diff --git a/docs/openapi/test-case-validation.md b/docs/openapi/test-case-validation.md index 50686b5ba0..84f2f53040 100644 --- a/docs/openapi/test-case-validation.md +++ b/docs/openapi/test-case-validation.md @@ -1,3 +1,9 @@ +--- +id: test-case-validation +title: Validate your OpenAPI spec against test data +description: Documetnation on how to use the `schema openapi test` command. +--- + ## OpenAPI Validation using Test Cases This is primarily performed by `backstage-repo-tools schema openapi test`. Any errors found in the generated specs can be either diff --git a/microsite/sidebars.json b/microsite/sidebars.json index ec224c59e3..380bd4514e 100644 --- a/microsite/sidebars.json +++ b/microsite/sidebars.json @@ -252,7 +252,9 @@ "type": "category", "label": "OpenAPI", "items": [ - "openapi/01-getting-started" + "openapi/01-getting-started", + "openapi/generate-client", + "openapi/test-case-validation" ] }, {