| OLD | NEW |
|---|
| (Empty) | |
| 1 { |
| 2 "basePath": "", |
| 3 "baseUrl": "https://firebaseremoteconfig.googleapis.com/", |
| 4 "batchPath": "batch", |
| 5 "canonicalName": "Firebase Remote Config", |
| 6 "description": "Firebase Remote Config API allows the 3P clients to manage R
emote Config conditions and parameters for Firebase applications.", |
| 7 "discoveryVersion": "v1", |
| 8 "documentationLink": "https://firebase.google.com/docs/remote-config/", |
| 9 "icons": { |
| 10 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| 11 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| 12 }, |
| 13 "id": "firebaseremoteconfig:v1", |
| 14 "kind": "discovery#restDescription", |
| 15 "name": "firebaseremoteconfig", |
| 16 "ownerDomain": "google.com", |
| 17 "ownerName": "Google", |
| 18 "parameters": { |
| 19 "pp": { |
| 20 "default": "true", |
| 21 "description": "Pretty-print response.", |
| 22 "location": "query", |
| 23 "type": "boolean" |
| 24 }, |
| 25 "oauth_token": { |
| 26 "description": "OAuth 2.0 token for the current user.", |
| 27 "location": "query", |
| 28 "type": "string" |
| 29 }, |
| 30 "bearer_token": { |
| 31 "description": "OAuth bearer token.", |
| 32 "location": "query", |
| 33 "type": "string" |
| 34 }, |
| 35 "upload_protocol": { |
| 36 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
| 37 "location": "query", |
| 38 "type": "string" |
| 39 }, |
| 40 "prettyPrint": { |
| 41 "default": "true", |
| 42 "description": "Returns response with indentations and line breaks."
, |
| 43 "location": "query", |
| 44 "type": "boolean" |
| 45 }, |
| 46 "fields": { |
| 47 "description": "Selector specifying which fields to include in a par
tial response.", |
| 48 "location": "query", |
| 49 "type": "string" |
| 50 }, |
| 51 "uploadType": { |
| 52 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 53 "location": "query", |
| 54 "type": "string" |
| 55 }, |
| 56 "callback": { |
| 57 "description": "JSONP", |
| 58 "location": "query", |
| 59 "type": "string" |
| 60 }, |
| 61 "$.xgafv": { |
| 62 "description": "V1 error format.", |
| 63 "enum": [ |
| 64 "1", |
| 65 "2" |
| 66 ], |
| 67 "enumDescriptions": [ |
| 68 "v1 error format", |
| 69 "v2 error format" |
| 70 ], |
| 71 "location": "query", |
| 72 "type": "string" |
| 73 }, |
| 74 "alt": { |
| 75 "default": "json", |
| 76 "description": "Data format for response.", |
| 77 "enum": [ |
| 78 "json", |
| 79 "media", |
| 80 "proto" |
| 81 ], |
| 82 "enumDescriptions": [ |
| 83 "Responses with Content-Type of application/json", |
| 84 "Media download with context-dependent Content-Type", |
| 85 "Responses with Content-Type of application/x-protobuf" |
| 86 ], |
| 87 "location": "query", |
| 88 "type": "string" |
| 89 }, |
| 90 "key": { |
| 91 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
| 92 "location": "query", |
| 93 "type": "string" |
| 94 }, |
| 95 "access_token": { |
| 96 "description": "OAuth access token.", |
| 97 "location": "query", |
| 98 "type": "string" |
| 99 }, |
| 100 "quotaUser": { |
| 101 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
| 102 "location": "query", |
| 103 "type": "string" |
| 104 } |
| 105 }, |
| 106 "protocol": "rest", |
| 107 "resources": { |
| 108 "projects": { |
| 109 "methods": { |
| 110 "updateRemoteConfig": { |
| 111 "description": "Update a RemoteConfig. We treat this as an a
lways-existing\nresource (when it is not found in our data store, we treat it as
version\n0, a template with zero conditions and zero parameters). Hence there a
re\nno Create or Delete operations. Returns the updated template when\nsuccessfu
l (and the updated eTag as a response header), or an error if\nthings go wrong.\
nPossible error messages:\n* VALIDATION_ERROR (HTTP status 400) with additional
details if the\ntemplate being passed in can not be validated.\n* AUTHENTICATION
_ERROR (HTTP status 401) if the request can not be\nauthenticate (e.g. no access
token, or invalid access token).\n* AUTHORIZATION_ERROR (HTTP status 403) if th
e request can not be\nauthorized (e.g. the user has no access to the specified p
roject id).\n* VERSION_MISMATCH (HTTP status 412) when trying to update when the
\nexpected eTag (passed in via the \"If-match\" header) is not specified, or\nis
specified but does does not match the current eTag.\n* Internal error (HTTP sta
tus 500) for Database problems or other internal\nerrors.", |
| 112 "httpMethod": "PUT", |
| 113 "id": "firebaseremoteconfig.projects.updateRemoteConfig", |
| 114 "parameterOrder": [ |
| 115 "project" |
| 116 ], |
| 117 "parameters": { |
| 118 "validateOnly": { |
| 119 "description": "Optional. Defaults to <code>false</c
ode> (UpdateRemoteConfig call should\nupdate the backend if there are no validat
ion/interal errors). May be set\nto <code>true</code> to indicate that, should n
o validation errors occur,\nthe call should return a \"200 OK\" instead of perfo
rming the update. Note\nthat other error messages (500 Internal Error, 412 Versi
on Mismatch, etc)\nmay still result after flipping to <code>false</code>, even i
f getting a\n\"200 OK\" when calling with <code>true</code>.", |
| 120 "location": "query", |
| 121 "type": "boolean" |
| 122 }, |
| 123 "project": { |
| 124 "description": "The GMP project identifier. Required
.\nSee note at the beginning of this file regarding project ids.", |
| 125 "location": "path", |
| 126 "pattern": "^projects/[^/]+$", |
| 127 "required": true, |
| 128 "type": "string" |
| 129 } |
| 130 }, |
| 131 "path": "v1/{+project}/remoteConfig", |
| 132 "request": { |
| 133 "$ref": "RemoteConfig" |
| 134 }, |
| 135 "response": { |
| 136 "$ref": "RemoteConfig" |
| 137 } |
| 138 }, |
| 139 "getRemoteConfig": { |
| 140 "description": "Get the latest version Remote Configuration
for a project.\nReturns the RemoteConfig as the payload, and also the eTag as a\
nresponse header.", |
| 141 "httpMethod": "GET", |
| 142 "id": "firebaseremoteconfig.projects.getRemoteConfig", |
| 143 "parameterOrder": [ |
| 144 "project" |
| 145 ], |
| 146 "parameters": { |
| 147 "project": { |
| 148 "description": "The GMP project identifier. Required
.\nSee note at the beginning of this file regarding project ids.", |
| 149 "location": "path", |
| 150 "pattern": "^projects/[^/]+$", |
| 151 "required": true, |
| 152 "type": "string" |
| 153 } |
| 154 }, |
| 155 "path": "v1/{+project}/remoteConfig", |
| 156 "response": { |
| 157 "$ref": "RemoteConfig" |
| 158 } |
| 159 } |
| 160 } |
| 161 } |
| 162 }, |
| 163 "revision": "20170901", |
| 164 "rootUrl": "https://firebaseremoteconfig.googleapis.com/", |
| 165 "schemas": { |
| 166 "RemoteConfigParameter": { |
| 167 "description": "While default_value and conditional_values are each
optional, at least one of\nthe two is required - otherwise, the parameter is mea
ningless (and an\nexception will be thrown by the validation logic).", |
| 168 "id": "RemoteConfigParameter", |
| 169 "properties": { |
| 170 "conditionalValues": { |
| 171 "additionalProperties": { |
| 172 "$ref": "RemoteConfigParameterValue" |
| 173 }, |
| 174 "description": "Optional - a map of (condition_name, value).
The condition_name of the\nhighest priority (the one listed first in the condit
ions array) determines\nthe value of this parameter.", |
| 175 "type": "object" |
| 176 }, |
| 177 "defaultValue": { |
| 178 "$ref": "RemoteConfigParameterValue", |
| 179 "description": "Optional - value to set the parameter to, wh
en none of the named conditions\nevaluate to <code>true</code>." |
| 180 } |
| 181 }, |
| 182 "type": "object" |
| 183 }, |
| 184 "RemoteConfigCondition": { |
| 185 "description": "A single RemoteConfig Condition. A list of these (b
ecause order matters) are\npart of a single RemoteConfig template.", |
| 186 "id": "RemoteConfigCondition", |
| 187 "properties": { |
| 188 "expression": { |
| 189 "description": "Required.", |
| 190 "type": "string" |
| 191 }, |
| 192 "tagColor": { |
| 193 "description": "Optional.\nThe display (tag) color of this c
ondition. This serves as part of a tag\n(in the future, we may add tag text as w
ell as tag color, but that is not\nyet implemented in the UI).\nThis value has n
o affect on the semantics of the delivered config and it\nis ignored by the back
end, except for passing it through write/read\nrequests.\nNot having this value
or having the \"CONDITION_DISPLAY_COLOR_UNSPECIFIED\"\nvalue (0) have the same m
eaning: Let the UI choose any valid color when\ndisplaying the condition.", |
| 194 "enum": [ |
| 195 "CONDITION_DISPLAY_COLOR_UNSPECIFIED", |
| 196 "BLUE", |
| 197 "BROWN", |
| 198 "CYAN", |
| 199 "DEEP_ORANGE", |
| 200 "GREEN", |
| 201 "INDIGO", |
| 202 "LIME", |
| 203 "ORANGE", |
| 204 "PINK", |
| 205 "PURPLE", |
| 206 "TEAL" |
| 207 ], |
| 208 "enumDescriptions": [ |
| 209 "", |
| 210 "Blue", |
| 211 "Brown", |
| 212 "Cyan", |
| 213 "aka \"Red Orange\"", |
| 214 "Green", |
| 215 "Indigo\n*", |
| 216 "Lime - Approved deviation from Material color palette", |
| 217 "Orange", |
| 218 "Pink", |
| 219 "Purple", |
| 220 "Teal" |
| 221 ], |
| 222 "type": "string" |
| 223 }, |
| 224 "name": { |
| 225 "description": "Required.\nA non empty and unique name of th
is condition.", |
| 226 "type": "string" |
| 227 } |
| 228 }, |
| 229 "type": "object" |
| 230 }, |
| 231 "RemoteConfigParameterValue": { |
| 232 "description": "A RemoteConfigParameter's \"value\" (either the defa
ult value, or the value\nassociated with a condition name) is either a string, o
r the\n\"use_in_app_default\" indicator (which means to leave out the parameter
from\nthe returned <key, value> map that is the output of the parameter fetch).\
nWe represent the \"use_in_app_default\" as a bool, but (when using the boolean\
ninstead of the string) it should always be <code>true</code>.", |
| 233 "id": "RemoteConfigParameterValue", |
| 234 "properties": { |
| 235 "useInAppDefault": { |
| 236 "description": "if true, omit the parameter from the map of
fetched parameter values", |
| 237 "type": "boolean" |
| 238 }, |
| 239 "value": { |
| 240 "description": "the string to set the parameter to", |
| 241 "type": "string" |
| 242 } |
| 243 }, |
| 244 "type": "object" |
| 245 }, |
| 246 "RemoteConfig": { |
| 247 "description": "*\nThe RemoteConfig consists of a list of conditions
(which can be\nthought of as named \"if\" statements) and a map of parameters (
parameter key\nto a stucture containing an optional default value, as well as a
optional\nsubmap of (condition name to value when that condition is true).", |
| 248 "id": "RemoteConfig", |
| 249 "properties": { |
| 250 "parameters": { |
| 251 "additionalProperties": { |
| 252 "$ref": "RemoteConfigParameter" |
| 253 }, |
| 254 "description": "Map of parameter keys to their optional defa
ult values and optional submap\nof (condition name : value). Order doesn't affec
t semantics, and so is\nsorted by the server. The 'key' values of the params mus
t be unique.", |
| 255 "type": "object" |
| 256 }, |
| 257 "conditions": { |
| 258 "description": "The list of named conditions. The order *doe
s* affect the semantics.\nThe condition_name values of these entries must be uni
que.\n\nThe resolved value of a config parameter P is determined as follow:\n* L
et Y be the set of values from the submap of P that refer to conditions\n that
evaluate to <code>true</code>.\n* If Y is non empty, the value is taken from the
specific submap in Y whose\n condition_name is the earliest in this condition
list.\n* Else, if P has a default value option (condition_name is empty) then\n
the value is taken from that option.\n* Else, parameter P has no value and is o
mitted from the config result.\n\nExample: parameter key \"p1\", default value \
"v1\", submap specified as\n{\"c1\": v2, \"c2\": v3} where \"c1\" and \"c2\" are
names of conditions in the\ncondition list (where \"c1\" in this example appear
s before \"c2\"). The\nvalue of p1 would be v2 as long as c1 is true. Otherwis
e, if c2 is true,\np1 would evaluate to v3, and if c1 and c2 are both false, p1
would evaluate\nto v1. If no default value was specified, and c1 and c2 were bo
th false,\nno value for p1 would be generated.", |
| 259 "items": { |
| 260 "$ref": "RemoteConfigCondition" |
| 261 }, |
| 262 "type": "array" |
| 263 } |
| 264 }, |
| 265 "type": "object" |
| 266 } |
| 267 }, |
| 268 "servicePath": "", |
| 269 "title": "Firebase Remote Config API", |
| 270 "version": "v1" |
| 271 } |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 3006323002:
Api-Roll 54: 2017-09-11 (Closed)
