|
97 | 97 | * }
|
98 | 98 | *
|
99 | 99 | * @property {string} typeUrl
|
100 |
| - * A URL/resource name whose content describes the type of the |
101 |
| - * serialized protocol buffer message. |
| 100 | + * A URL/resource name that uniquely identifies the type of the serialized |
| 101 | + * protocol buffer message. The last segment of the URL's path must represent |
| 102 | + * the fully qualified name of the type (as in |
| 103 | + * `path/google.protobuf.Duration`). The name should be in a canonical form |
| 104 | + * (e.g., leading "." is not accepted). |
102 | 105 | *
|
103 |
| - * For URLs which use the scheme `http`, `https`, or no scheme, the |
104 |
| - * following restrictions and interpretations apply: |
| 106 | + * In practice, teams usually precompile into the binary all types that they |
| 107 | + * expect it to use in the context of Any. However, for URLs which use the |
| 108 | + * scheme `http`, `https`, or no scheme, one can optionally set up a type |
| 109 | + * server that maps type URLs to message definitions as follows: |
105 | 110 | *
|
106 | 111 | * * If no scheme is provided, `https` is assumed.
|
107 |
| - * * The last segment of the URL's path must represent the fully |
108 |
| - * qualified name of the type (as in `path/google.protobuf.Duration`). |
109 |
| - * The name should be in a canonical form (e.g., leading "." is |
110 |
| - * not accepted). |
111 | 112 | * * An HTTP GET on the URL must yield a google.protobuf.Type
|
112 | 113 | * value in binary format, or produce an error.
|
113 | 114 | * * Applications are allowed to cache lookup results based on the
|
|
116 | 117 | * on changes to types. (Use versioned type names to manage
|
117 | 118 | * breaking changes.)
|
118 | 119 | *
|
| 120 | + * Note: this functionality is not currently available in the official |
| 121 | + * protobuf release, and it is not used for type URLs beginning with |
| 122 | + * type.googleapis.com. |
| 123 | + * |
119 | 124 | * Schemes other than `http`, `https` (or the empty scheme) might be
|
120 | 125 | * used with implementation specific semantics.
|
121 | 126 | *
|
|
0 commit comments