From da1adcacf08802844fab8dfa94528626adfef456 Mon Sep 17 00:00:00 2001 From: Piper Date: Wed, 20 Dec 2023 09:57:49 -0800 Subject: [PATCH] Fix typos in README.md (#423) --- README.md | 6 +++--- openapiv3/README.md | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 9052de3f..2ea85c46 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ can import packages from `gnostic-models` instead of `gnostic`. [google/gnostic-grpc](https://github.com/google/gnostic-grpc) contains a gnostic plugin that can generate an annotated Protocol Buffer description of an -API that, when transcode, produces an API that conforms to a specified OpenAPI +API that, when transcoded, produces an API that conforms to a specified OpenAPI document. To go from protobuf to OpenAPI, see the [protoc-gen-openapi](cmd/protoc-gen-openapi) tool in this project. @@ -69,12 +69,12 @@ and later. git clone https://github.com/google/gnostic cd gnostic -2. Verify that you have a local installation of `protoc`. You can get protoc +2. Verify that you have a local installation of `protoc`. You can get `protoc` [here](https://github.com/protocolbuffers/protobuf). 3. Build **gnostic** with `make`. This uses [go generate](https://blog.golang.org/generate) to build support code - including code generated by `protoc` and the Go protoc plugin, which is + including code generated by `protoc` and the Go `protoc` plugin, which is automatically downloaded from [github.com/golang/protobuf](https://github.com/golang/protobuf) by the [COMPILE-PROTOS.sh](COMPILE-PROTOS.sh) script. This also builds all plugins diff --git a/openapiv3/README.md b/openapiv3/README.md index 0b015bce..5184f7fa 100644 --- a/openapiv3/README.md +++ b/openapiv3/README.md @@ -7,13 +7,13 @@ Gnostic applications and plugins can use OpenAPIv3.proto to generate Protocol Buffer support code for their preferred languages. OpenAPIv3.go is used by Gnostic to read JSON and YAML OpenAPI descriptions into -the Protocol Buffer-based datastructures generated from OpenAPIv3.proto. +the Protocol Buffer-based data structures generated from OpenAPIv3.proto. OpenAPIv3.proto and OpenAPIv3.go are generated by the Gnostic compiler -generator, and OpenAPIv3.pb.go is generated by protoc, the Protocol Buffer -compiler, and protoc-gen-go, the Protocol Buffer Go code generation plugin. +generator, and OpenAPIv3.pb.go is generated by `protoc`, the Protocol Buffer +compiler, and `protoc-gen-go`, the Protocol Buffer Go code generation plugin. -openapi-3.1.json is a JSON schema for OpenAPI 3.1 that is automatically +`openapi-3.1.json` is a JSON schema for OpenAPI 3.1 that is automatically generated from the OpenAPI 3.1 specification. It is not an official JSON Schema for OpenAPI.