-
Notifications
You must be signed in to change notification settings - Fork 254
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[protoc-gen-openapi] Support google.protobuf.Any and google.rpc.Status (
#327) * support google.rpc.Status and google.protobuf.Any. Also fix the fully qualified naming of google.protobuf.Value * updated the non-fully-qualified names for Value and Any types, modified their descriptions, and added nullable to Value * add restriction on the object type for value messages. * make GoogleProtobufValue typeless which accomplishes what we want with less code
- Loading branch information
1 parent
ec4d35c
commit e954645
Showing
12 changed files
with
360 additions
and
122 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| // Copyright 2020 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| syntax = "proto3"; | ||
|
|
||
| package google.rpc; | ||
|
|
||
| import "google/protobuf/any.proto"; | ||
|
|
||
| option cc_enable_arenas = true; | ||
| option go_package = "google.golang.org/genproto/googleapis/rpc/status;status"; | ||
| option java_multiple_files = true; | ||
| option java_outer_classname = "StatusProto"; | ||
| option java_package = "com.google.rpc"; | ||
| option objc_class_prefix = "RPC"; | ||
|
|
||
| // The `Status` type defines a logical error model that is suitable for | ||
| // different programming environments, including REST APIs and RPC APIs. It is | ||
| // used by [gRPC](https://github.com/grpc). Each `Status` message contains | ||
| // three pieces of data: error code, error message, and error details. | ||
| // | ||
| // You can find out more about this error model and how to work with it in the | ||
| // [API Design Guide](https://cloud.google.com/apis/design/errors). | ||
| message Status { | ||
| // The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. | ||
| int32 code = 1; | ||
|
|
||
| // A developer-facing error message, which should be in English. Any | ||
| // user-facing error message should be localized and sent in the | ||
| // [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. | ||
| string message = 2; | ||
|
|
||
| // A list of messages that carry the error details. There is a common set of | ||
| // message types for APIs to use. | ||
| repeated google.protobuf.Any details = 3; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
32 changes: 32 additions & 0 deletions
32
cmd/protoc-gen-openapi/examples/tests/rpctypes/message.proto
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| // Copyright 2021 Google LLC. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // | ||
|
|
||
| syntax = "proto3"; | ||
|
|
||
| package tests.rpctypes.message.v1; | ||
|
|
||
| import "google/protobuf/empty.proto"; | ||
| import "google/api/annotations.proto"; | ||
| import "google/rpc/status.proto"; | ||
|
|
||
| option go_package = "github.com/google/gnostic/apps/protoc-gen-openapi/examples/tests/rpctypes/message/v1;message"; | ||
|
|
||
| service Status { | ||
| rpc GetStatus(google.protobuf.Empty) returns (google.rpc.Status) { | ||
| option(google.api.http) = { | ||
| get: "/v1/status" | ||
| }; | ||
| } | ||
| } |
Oops, something went wrong.