common/api/buildbucket/swarmbucket/v1/swarmbucket-api.json

{
 "kind": "discovery#restDescription",
 "etag": "\"RnkXbyw9us4_w3H-FU6An0C4oYs/lsH1QT-cqP1N0YIBt5a4z6BEjfE\"",
 "discoveryVersion": "v1",
 "id": "swarmbucket:v1",
 "name": "swarmbucket",
 "version": "v1",
 "title": "Buildbucket-Swarming integration",
 "description": "API specific to swarmbucket.",
 "icons": {
  "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
  "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
 },
 "protocol": "rest",
 "baseUrl": "https://cr-buildbucket.appspot.com/_ah/api/swarmbucket/v1/",
 "basePath": "/_ah/api/swarmbucket/v1/",
 "rootUrl": "https://cr-buildbucket.appspot.com/_ah/api/",
 "servicePath": "swarmbucket/v1/",
 "batchPath": "batch",
 "parameters": {
  "alt": {
   "type": "string",
   "description": "Data format for the response.",
   "default": "json",
   "enum": [
    "json"
   ],
   "enumDescriptions": [
    "Responses with Content-Type of application/json"
   ],
   "location": "query"
  },
  "fields": {
   "type": "string",
   "description": "Selector specifying which fields to include in a partial response.",
   "location": "query"
  },
  "key": {
   "type": "string",
   "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
   "location": "query"
  },
  "oauth_token": {
   "type": "string",
   "description": "OAuth 2.0 token for the current user.",
   "location": "query"
  },
  "prettyPrint": {
   "type": "boolean",
   "description": "Returns response with indentations and line breaks.",
   "default": "true",
   "location": "query"
  },
  "quotaUser": {
   "type": "string",
   "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
   "location": "query"
  },
  "userIp": {
   "type": "string",
   "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
   "location": "query"
  }
 },
 "auth": {
  "oauth2": {
   "scopes": {
    "https://www.googleapis.com/auth/userinfo.email": {
     "description": "View your email address"
    }
   }
  }
 },
 "schemas": {
  "ApiPubSubCallbackMessage": {
   "id": "ApiPubSubCallbackMessage",
   "type": "object",
   "properties": {
    "auth_token": {
     "type": "string"
    },
    "topic": {
     "type": "string"
    },
    "user_data": {
     "type": "string"
    }
   }
  },
  "ApiPutRequestMessage": {
   "id": "ApiPutRequestMessage",
   "type": "object",
   "properties": {
    "bucket": {
     "type": "string"
    },
    "client_operation_id": {
     "type": "string"
    },
    "lease_expiration_ts": {
     "type": "string",
     "format": "int64"
    },
    "parameters_json": {
     "type": "string"
    },
    "pubsub_callback": {
     "$ref": "ApiPubSubCallbackMessage"
    },
    "tags": {
     "type": "array",
     "items": {
      "type": "string"
     }
    }
   }
  },
  "SwarmingSwarmbucketApiBucketMessage": {
   "id": "SwarmingSwarmbucketApiBucketMessage",
   "type": "object",
   "properties": {
    "builders": {
     "type": "array",
     "items": {
      "$ref": "SwarmingSwarmbucketApiBuilderMessage"
     }
    },
    "name": {
     "type": "string"
    }
   }
  },
  "SwarmingSwarmbucketApiBuilderMessage": {
   "id": "SwarmingSwarmbucketApiBuilderMessage",
   "type": "object",
   "properties": {
    "category": {
     "type": "string"
    },
    "name": {
     "type": "string"
    }
   }
  },
  "SwarmingSwarmbucketApiGetBuildersResponseMessage": {
   "id": "SwarmingSwarmbucketApiGetBuildersResponseMessage",
   "type": "object",
   "properties": {
    "buckets": {
     "type": "array",
     "items": {
      "$ref": "SwarmingSwarmbucketApiBucketMessage"
     }
    }
   }
  },
  "SwarmingSwarmbucketApiGetTaskDefinitionRequestMessage": {
   "id": "SwarmingSwarmbucketApiGetTaskDefinitionRequestMessage",
   "type": "object",
   "properties": {
    "api_explorer_link": {
     "type": "boolean"
    },
    "build_request": {
     "$ref": "ApiPutRequestMessage"
    }
   }
  },
  "SwarmingSwarmbucketApiGetTaskDefinitionResponseMessage": {
   "id": "SwarmingSwarmbucketApiGetTaskDefinitionResponseMessage",
   "type": "object",
   "properties": {
    "api_explorer_link": {
     "type": "string"
    },
    "task_definition": {
     "type": "string"
    }
   }
  }
 },
 "methods": {
  "get_builders": {
   "id": "swarmbucket.get_builders",
   "path": "builders",
   "httpMethod": "GET",
   "description": "Returns defined swarmbucket builders. Can be used by code review tool to discover builders.",
   "response": {
    "$ref": "SwarmingSwarmbucketApiGetBuildersResponseMessage"
   },
   "scopes": [
    "https://www.googleapis.com/auth/userinfo.email"
   ]
  },
  "get_task_def": {
   "id": "swarmbucket.get_task_def",
   "path": "get_task_def",
   "httpMethod": "POST",
   "description": "Returns a swarming task definition for a build request.",
   "request": {
    "$ref": "SwarmingSwarmbucketApiGetTaskDefinitionRequestMessage",
    "parameterName": "resource"
   },
   "response": {
    "$ref": "SwarmingSwarmbucketApiGetTaskDefinitionResponseMessage"
   },
   "scopes": [
    "https://www.googleapis.com/auth/userinfo.email"
   ]
  }
 }
}