mirror of
https://github.com/etcd-io/etcd.git
synced 2024-09-27 06:25:44 +00:00
b4f49a55a5
The schwag was introduced to generate swagger with authorization support [1][1] in 2017. And in 2018, the grpc-gateway supports to render security fields by protoc-gen-swagger [2][2]. After several years, I think it's good to use upstream protoc supports. NOTE: The json's key in `rpc.swagger.json` has been reordered so that it seems that there's a lot of changes. How to verify it: ```bash $ # use jq -S to sort the key $ latest_commit="https://raw.githubusercontent.com/etcd-io/etcd/228f493c7697ce3e9d3a1d831bcffad175846c75/Documentation/dev-guide/apispec/swagger/rpc.swagger.json" $ curl -s "${latest_commit}" | jq -S . > /tmp/old.json $ cat Documentation/dev-guide/apispec/swagger/rpc.swagger.json | jq -S . > /tmp/new.json $ diff --color -u /tmp/old.json /tmp/new.json ``` ```diff --- /tmp/old.json 2023-04-26 10:58:07.142311861 +0800 +++ /tmp/new.json 2023-04-26 10:58:12.170299194 +0800 @@ -1523,11 +1523,14 @@ "type": "object" }, "protobufAny": { + "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(&foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := &pb.Foo{...}\n any, err := ptypes.MarshalAny(foo)\n ...\n foo := &pb.Foo{}\n if err := ptypes.UnmarshalAny(any, foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": <string>,\n \"lastName\": <string>\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }", "properties": { "type_url": { + "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics.", "type": "string" }, "value": { + "description": "Must be a valid serialized protocol buffer of the above specified type.", "format": "byte", "type": "string" } ``` REF: 1: <https://github.com/etcd-io/etcd/pull/7999#issuecomment-307512043> 2: <https://github.com/grpc-ecosystem/grpc-gateway/pull/547> Signed-off-by: Wei Fu <fuweid89@gmail.com>
89 lines
4.0 KiB
Modula-2
89 lines
4.0 KiB
Modula-2
module go.etcd.io/etcd/tools/v3
|
|
|
|
go 1.19
|
|
|
|
require (
|
|
github.com/alexkohler/nakedret v1.0.2
|
|
github.com/chzchzchz/goword v0.0.0-20170907005317-a9744cb52b03
|
|
github.com/cloudflare/cfssl v1.6.4
|
|
github.com/coreos/license-bill-of-materials v0.0.0-20190913234955-13baff47494e
|
|
github.com/gogo/protobuf v1.3.2
|
|
github.com/google/addlicense v1.1.1
|
|
github.com/gordonklaus/ineffassign v0.0.0-20210914165742-4cc7213b9bc8
|
|
github.com/grpc-ecosystem/grpc-gateway v1.16.0
|
|
github.com/gyuho/gocovmerge v0.0.0-20171205171859-50c7e6afd535
|
|
github.com/mdempsky/unconvert v0.0.0-20200228143138-95ecdbfc0b5f
|
|
github.com/mgechev/revive v1.3.1
|
|
github.com/mikefarah/yq/v4 v4.33.3
|
|
go.etcd.io/gofail v0.1.0
|
|
go.etcd.io/protodoc v0.0.0-20180829002748-484ab544e116
|
|
go.etcd.io/raft/v3 v3.0.0-20221201111702-eaa6808e1f7a
|
|
gotest.tools/gotestsum v1.10.0
|
|
gotest.tools/v3 v3.4.0
|
|
honnef.co/go/tools v0.4.3
|
|
mvdan.cc/unparam v0.0.0-20220316160445-06cc5682983b
|
|
)
|
|
|
|
require (
|
|
github.com/BurntSushi/toml v1.2.1 // indirect
|
|
github.com/a8m/envsubst v1.4.2 // indirect
|
|
github.com/akhenakh/hunspellgo v0.0.0-20160221122622-9db38fa26e19 // indirect
|
|
github.com/alecthomas/participle/v2 v2.0.0 // indirect
|
|
github.com/bmatcuk/doublestar/v4 v4.0.2 // indirect
|
|
github.com/chavacava/garif v0.0.0-20230227094218-b8c73b2037b8 // indirect
|
|
github.com/dimchansky/utfbom v1.1.1 // indirect
|
|
github.com/dnephin/pflag v1.0.7 // indirect
|
|
github.com/elliotchance/orderedmap v1.5.0 // indirect
|
|
github.com/fatih/color v1.15.0 // indirect
|
|
github.com/fatih/structtag v1.2.0 // indirect
|
|
github.com/fsnotify/fsnotify v1.5.4 // indirect
|
|
github.com/ghodss/yaml v1.0.0 // indirect
|
|
github.com/go-logr/logr v1.2.0 // indirect
|
|
github.com/go-sql-driver/mysql v1.6.0 // indirect
|
|
github.com/goccy/go-json v0.10.2 // indirect
|
|
github.com/goccy/go-yaml v1.11.0 // indirect
|
|
github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b // indirect
|
|
github.com/golang/protobuf v1.5.3 // indirect
|
|
github.com/google/certificate-transparency-go v1.1.4 // indirect
|
|
github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 // indirect
|
|
github.com/inconshreveable/mousetrap v1.1.0 // indirect
|
|
github.com/jinzhu/copier v0.3.5 // indirect
|
|
github.com/jmhodges/clock v1.2.0 // indirect
|
|
github.com/jmoiron/sqlx v1.3.3 // indirect
|
|
github.com/kisielk/sqlstruct v0.0.0-20201105191214-5f3e10d3ab46 // indirect
|
|
github.com/lib/pq v1.10.1 // indirect
|
|
github.com/magiconair/properties v1.8.7 // indirect
|
|
github.com/mattn/go-colorable v0.1.13 // indirect
|
|
github.com/mattn/go-isatty v0.0.17 // indirect
|
|
github.com/mattn/go-runewidth v0.0.13 // indirect
|
|
github.com/mattn/go-sqlite3 v1.14.15 // indirect
|
|
github.com/mgechev/dots v0.0.0-20210922191527-e955255bf517 // indirect
|
|
github.com/mitchellh/go-homedir v1.1.0 // indirect
|
|
github.com/olekukonko/tablewriter v0.0.5 // indirect
|
|
github.com/pelletier/go-toml/v2 v2.0.7 // indirect
|
|
github.com/pkg/errors v0.9.1 // indirect
|
|
github.com/rivo/uniseg v0.2.0 // indirect
|
|
github.com/spf13/cobra v1.7.0 // indirect
|
|
github.com/spf13/pflag v1.0.5 // indirect
|
|
github.com/trustmaster/go-aspell v0.0.0-20200701131845-c2b1f55bec8f // indirect
|
|
github.com/weppos/publicsuffix-go v0.15.1-0.20210511084619-b1f36a2d6c0b // indirect
|
|
github.com/zmap/zcrypto v0.0.0-20210511125630-18f1e0152cfc // indirect
|
|
github.com/zmap/zlint/v3 v3.1.0 // indirect
|
|
golang.org/x/crypto v0.8.0 // indirect
|
|
golang.org/x/exp/typeparams v0.0.0-20221208152030-732eee02a75a // indirect
|
|
golang.org/x/mod v0.10.0 // indirect
|
|
golang.org/x/net v0.9.0 // indirect
|
|
golang.org/x/sync v0.1.0 // indirect
|
|
golang.org/x/sys v0.7.0 // indirect
|
|
golang.org/x/term v0.7.0 // indirect
|
|
golang.org/x/text v0.9.0 // indirect
|
|
golang.org/x/tools v0.8.0 // indirect
|
|
golang.org/x/xerrors v0.0.0-20220609144429-65e65417b02f // indirect
|
|
google.golang.org/genproto v0.0.0-20220706185917-7780775163c4 // indirect
|
|
google.golang.org/protobuf v1.30.0 // indirect
|
|
gopkg.in/op/go-logging.v1 v1.0.0-20160211212156-b2cb9fa56473 // indirect
|
|
gopkg.in/yaml.v2 v2.4.0 // indirect
|
|
gopkg.in/yaml.v3 v3.0.1 // indirect
|
|
k8s.io/klog/v2 v2.80.1 // indirect
|
|
)
|