From 4a1689862c5104e92c279a240c15784acf16d2f6 Mon Sep 17 00:00:00 2001 From: secustor Date: Wed, 20 Mar 2024 22:36:24 +0100 Subject: [PATCH] docs(openapi): document JAVA requirement for client generation Signed-off-by: secustor --- docs/openapi/01-getting-started.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/openapi/01-getting-started.md b/docs/openapi/01-getting-started.md index 5b9908756f..5e1af76a5c 100644 --- a/docs/openapi/01-getting-started.md +++ b/docs/openapi/01-getting-started.md @@ -35,6 +35,8 @@ There are two required npm packages before we start, 1. `@backstage/repo-tools`, this package contains all OpenAPI related commands for your plugins. We will be using this throughout the tutorial. 2. `@opticdev/optic`, this package is a dependency of `@backstage/repo-tools` but is only required for OpenAPI related commands. +Further, for generating the client a `java` binary has to be available on your PATH. + You should install both of the above packages in the _root_ of your workspace. ## Storing your OpenAPI specification