Merge pull request #21 from micovery/doc_fixes

doc: minor changes to doc markdown
apigee · Oct 30, 2024 · 199d301 · 199d301
2 parents 116eb07 + 19665af
commit 199d301
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 6 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -25,7 +25,7 @@ The `apigee-go-gen` CLI tool streamlines your Apigee development experience usin
 
 * **[Transformation commands](./transform/index.md)** Easily convert between Apigee's API proxy format and YAML for better readability and management.
 * **[Template rendering commands](./render/index.md)**  Enjoy powerful customization and dynamic configuration options, inspired by the flexibility of Helm using the Go [text/template](https://pkg.go.dev/text/template) engine.
-* **[Mock generation command](./mock/commands/mock-oas.md)** Effortlessly create a mock API proxy from your OpenAPI 3.X spec, complete with dynamic response bodies, headers, and status codes.
+* **[Mock generation command](./mock/mock-openapi-spec.md)** Effortlessly create a mock API proxy from your OpenAPI 3.X spec, complete with dynamic response bodies, headers, and status codes.
 
 By using this tool alongside the [Apigee CLI](https://github.com/apigee/apigeecli), you'll unlock a highly customizable workflow. This is perfect for both streamlined local development and robust CI/CD pipelines.
 

diff --git a/docs/mock/commands/mock-oas.md b/docs/mock/commands/mock-oas.md
@@ -27,3 +27,5 @@ The `mock oas` command takes the following parameters:
   -h, --help            help for oas
 ```
 
+> See how the mock API proxy bundle works over at the [Mock OpenAPI Spec](../mock-openapi-spec.md) doc page
+
diff --git a/docs/transform/commands/oas-overlay.md b/docs/transform/commands/oas-overlay.md
@@ -24,16 +24,17 @@ The `oas-overlay` command takes the following parameters:
 * `--overlay` is the path to the OpenAPI Overlay (either as JSON or YAML)
 
 * `--spec` (*optional*)  is the path to the OpenAPI Spec  to transform (either as JSON or YAML)
+
+* `--output` is the document to be created (either as JSON or YAML)
+
 
 > The `--spec` parameter is optional. If omitted, the OAS path is read form the `extends` property of the overlay.
 > In this case, the path is relative to the location of the overlay file itself.
 
-* `--output` is the document to be created (either as JSON or YAML)
-
->  Full path is created if it does not exist (like `mkdir -p`)
 
 
-> You may omit the `--output` flags to write to stdout
+> You may omit the `--output` flags to write to stdout  
+>  Full path is created if the `--output` does not exist (like `mkdir -p`)
 
 
 

diff --git a/docs/transform/index.md b/docs/transform/index.md
@@ -34,5 +34,8 @@ The `apigee-go-gen` includes the following set of `transform` commands to help y
 
 * [oas2-to-oas3](./commands/oas2-to-oas3.md) - Transforms an OpenAPI 2 spec (also known as Swagger) into OpenAPI 3
 
-* [resolve-refs](./commands/resolve-refs.md) - Replace external $refs (JSONRefs) in input YAML or JSON doc with actual values
+* [resolve-refs](./commands/resolve-refs.md) - Replace external $refs (JSONRefs) in a YAML or JSON doc with actual values
+
+* [oas-overlay](./commands/oas-overlay.md) - Transforms an Open API spec by applying an [overlay](https://github.com/OAI/Overlay-Specification/blob/main/versions/1.0.0.md) file
+
Original file line number	Diff line number	Diff line change
Expand Up		@@ -27,3 +27,5 @@ The `mock oas` command takes the following parameters:
		-h, --help help for oas
		```

		> See how the mock API proxy bundle works over at the [Mock OpenAPI Spec](../mock-openapi-spec.md) doc page