Skip to content

Commit 1146f5c

Browse files
authored
Protovalidate is capitalized and one word (#79)
* Proto Validate -> Protovalidate * Capitalize Protovalidate when referring to the project as a whole.
1 parent 722b834 commit 1146f5c

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Generate OpenAPI v3.1 from protobuf matching the [Connect protocol](https://conn
1111

1212
Features:
1313
- Support for OpenAPIv3.1 (which has support for jsonschema)
14-
- Support for many [protovalidate](https://github.com/bufbuild/protovalidate) options ([more info](protovalidate.md))
14+
- Support for many [Protovalidate](https://github.com/bufbuild/protovalidate) options ([more info](protovalidate.md))
1515
- Support for many [OpenAPIv3](https://github.com/google/gnostic/blob/main/openapiv3/annotations.proto) options from the [google/gnostic project](https://github.com/google/gnostic) protobufs ([more info](gnostic.md))
1616
- Support for [gRPC-Gateway annotations](https://github.com/grpc-ecosystem/grpc-gateway) ([more info](grpcgateway.md))
1717
- Has [an easy interface](https://pkg.go.dev/github.com/sudorandom/protoc-gen-connect-openapi/converter) for generating OpenAPI specs within the process
@@ -89,10 +89,10 @@ plugins:
8989
```
9090
And then run `buf generate`. See [the documentation on buf generate](https://buf.build/docs/reference/cli/buf/generate#usage) for more help.
9191

92-
### Proto Validate Support
93-
protoc-gen-connect-openapi also has support for many [protovalidate](https://github.com/bufbuild/protovalidate) annotations. Note that not every protovalidate constraint translates clearly to OpenAPI.
92+
### Protovalidate Support
93+
protoc-gen-connect-openapi also has support for many [Protovalidate](https://github.com/bufbuild/protovalidate) annotations. Note that not every Protovalidate constraint translates clearly to OpenAPI.
9494

95-
[See the protovalidate documentation page for more information](protovalidate.md)
95+
[See the Protovalidate documentation page for more information](protovalidate.md)
9696

9797
### gRPC-Gateway annotations
9898
protoc-gen-connect-openapi also has support for the [gRPC-Gateway annotations](https://grpc-ecosystem.github.io/grpc-gateway/docs/tutorials/adding_annotations/) provided by the [google/api/annotations.proto](https://github.com/googleapis/googleapis/blob/master/google/api/annotations.proto).

protovalidate.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Proto Validate Support
2-
protoc-gen-connect-openapi has support for many [protovalidate](https://github.com/bufbuild/protovalidate) annotations. Note that not every protovalidate constraint translates clearly to OpenAPI.
1+
# Protovalidate Support
2+
protoc-gen-connect-openapi has support for many [Protovalidate](https://github.com/bufbuild/protovalidate) annotations. Note that not every Protovalidate constraint translates clearly to OpenAPI.
33

44
Your protobuf that looks like this:
55
```protobuf

0 commit comments

Comments
 (0)