Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix typos in README.md #423

Merged
merged 2 commits into from
Dec 20, 2023
Merged

Fix typos in README.md #423

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1cb99dd
Update README.md
piperchester Dec 19, 2023
2ab860c
WIP
piperchester Dec 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions openapiv3/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Loading