Reference openapi CLI tools as ./vendor/bin/openapi (#1656)

zircote · Sep 26, 2024 · 68a19b8 · 68a19b8
1 parent ff78ab1
commit 68a19b8
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/docs/guide/generating-openapi-documents.md b/docs/guide/generating-openapi-documents.md
@@ -1,8 +1,8 @@
 # Generating OpenAPI documents
 
-## `./bin/openapi`
+## `./vendor/bin/openapi`
 
-`swagger-php` includes a command line tool `./bin/openapi`. This can be used to generate OpenAPI documents.
+`swagger-php` includes a command line tool `./vendor/bin/openapi`. This can be used to generate OpenAPI documents.
 
 ```shell
 > ./vendor/bin/openapi app -o openapi.yaml
@@ -18,7 +18,7 @@ The `--format` option can be used to force a specific format.
 For a list of all available options use the `-h` option
 
 ```shell
-> ./bin/openapi -h
+> ./vendor/bin/openapi -h
 
 Usage: openapi [--option value] [/path/to/project ...]
 

diff --git a/docs/index.md b/docs/index.md
@@ -38,7 +38,7 @@ Add `swagger-php` attributes or annotations to your source code.
 ### 3. Generate OpenAPI documentation
 
 ```shell
-> ./bin/openapi src -o openapi.yaml
+> ./vendor/bin/openapi src -o openapi.yaml
 ```
 
 ### 4. Explore and interact with your API