Regenerated library to pick up latest schema changes

Author: petemoore

codegenerator/model/model-data.txt

@@ -4653,54 +4653,57 @@ Version     = '0'
 Schema      = 'http://schemas.taskcluster.net/base/v1/api-reference.json#'
 Title       = 'Task Index API Documentation'
 Description = 'The task index, typically available at `index.taskcluster.net`, is
-responsible for indexing tasks. In order to ensure that tasks can be
-located by recency and/or arbitrary strings. Common use-cases includes
+responsible for indexing tasks. The service ensures that tasks can be
+located by recency and/or arbitrary strings. Common use-cases include:
 
  * Locate tasks by git or mercurial `<revision>`, or
  * Locate latest task from given `<branch>`, such as a release.
 
-**Index hierarchy**, tasks are indexed in a dot `.` separated hierarchy
-called a namespace. For example a task could be indexed in
-`<revision>.linux-64.release-build`. In this case the following
+**Index hierarchy**, tasks are indexed in a dot (`.`) separated hierarchy
+called a namespace. For example a task could be indexed with the index path
+`some-app.<revision>.linux-64.release-build`. In this case the following
 namespaces is created.
 
- 1. `<revision>`, and,
- 2. `<revision>.linux-64`
+ 1. `some-app`,
+ 1. `some-app.<revision>`, and,
+ 2. `some-app.<revision>.linux-64`
 
-The inside the namespace `<revision>` you can find the namespace
-`<revision>.linux-64` inside which you can find the indexed task
-`<revision>.linux-64.release-build`. In this example you'll be able to
-find build for a given revision.
+Inside the namespace `some-app.<revision>` you can find the namespace
+`some-app.<revision>.linux-64` inside which you can find the indexed task
+`some-app.<revision>.linux-64.release-build`. This is an example of indexing
+builds for a given platform and revision.
 
 **Task Rank**, when a task is indexed, it is assigned a `rank` (defaults
 to `0`). If another task is already indexed in the same namespace with
-the same lower or equal `rank`, the task will be overwritten. For example
-consider a task indexed as `mozilla-central.linux-64.release-build`, in
-this case on might choose to use a unix timestamp or mercurial revision
+lower or equal `rank`, the index for that task will be overwritten. For example
+consider index path `mozilla-central.linux-64.release-build`. In
+this case one might choose to use a UNIX timestamp or mercurial revision
 number as `rank`. This way the latest completed linux 64 bit release
 build is always available at `mozilla-central.linux-64.release-build`.
 
-**Indexed Data**, when a task is located in the index you will get the
-`taskId` and an additional user-defined JSON blob that was indexed with
-task. You can use this to store additional information you would like to
-get additional from the index.
+Note that this does mean index paths are not immutable: the same path may
+point to a different task now than it did a moment ago.
+
+**Indexed Data**, when a task is retrieved from the index the result includes
+a `taskId` and an additional user-defined JSON blob that was indexed with
+the task.
 
 **Entry Expiration**, all indexed entries must have an expiration date.
 Typically this defaults to one year, if not specified. If you are
 indexing tasks to make it easy to find artifacts, consider using the
-expiration date that the artifacts is assigned.
+artifact's expiration date.
 
 **Valid Characters**, all keys in a namespace `<key1>.<key2>` must be
 in the form `/[a-zA-Z0-9_!~*'()%-]+/`. Observe that this is URL-safe and
 that if you strictly want to put another character you can URL encode it.
 
 **Indexing Routes**, tasks can be indexed using the API below, but the
-most common way to index tasks is adding a custom route on the following
-form `index.<namespace>`. In-order to add this route to a task you'll
-need the following scope `queue:route:index.<namespace>`. When a task has
-this route, it'll be indexed when the task is **completed successfully**.
+most common way to index tasks is adding a custom route to `task.routes` of the
+form `index.<namespace>`. In order to add this route to a task you'll
+need the scope `queue:route:index.<namespace>`. When a task has
+this route, it will be indexed when the task is **completed successfully**.
 The task will be indexed with `rank`, `data` and `expires` as specified
-in `task.extra.index`, see example below:
+in `task.extra.index`. See the example below:
 
 ```js
 {
@@ -4718,7 +4721,7 @@ in `task.extra.index`, see example below:
       // rank <= 4000 (defaults to zero)
       rank:       4000,
 
-      // Specify when the entries expires (Defaults to 1 year)
+      // Specify when the entries expire (Defaults to 1 year)
       expires:          new Date().toJSON(),
 
       // A little informal data to store along with taskId
@@ -4736,26 +4739,26 @@ in `task.extra.index`, see example below:
 ```
 
 **Remark**, when indexing tasks using custom routes, it's also possible
-to listen for messages about these tasks. Which is quite convenient, for
-example one could bind to `route.index.mozilla-central.*.release-build`,
+to listen for messages about these tasks. For
+example one could bind to `route.index.some-app.*.release-build`,
 and pick up all messages about release builds. Hence, it is a
 good idea to document task index hierarchies, as these make up extension
 points in their own.'
 Base URL    = 'https://index.taskcluster.net/v1'
 Entry 0     =
     Entry Type        = 'function'
     Entry Method      = 'get'
-    Entry Route       = '/task/<namespace>'
-    Entry Args        = '[namespace]'
+    Entry Route       = '/task/<indexPath>'
+    Entry Args        = '[indexPath]'
     Entry Query        = '[]'
     Entry Name        = 'findTask'
     Entry Stability   = 'stable'
     Entry Scopes      = '[]'
     Entry Input       = ''
     Entry Output      = 'http://schemas.taskcluster.net/index/v1/indexed-task-response.json#'
     Entry Title       = 'Find Indexed Task'
-    Entry Description = 'Find task by namespace, if no task existing for the given namespace, this
-API end-point respond `404`.'
+    Entry Description = 'Find a task by index path, returning the highest-rank task with that path. If no
+task exists for the given path, this API end-point will respond with a 404 status.'
 Entry 1     =
     Entry Type        = 'function'
     Entry Method      = 'post'
@@ -4768,14 +4771,13 @@ Entry 1     =
     Entry Input       = 'http://schemas.taskcluster.net/index/v1/list-namespaces-request.json#'
     Entry Output      = 'http://schemas.taskcluster.net/index/v1/list-namespaces-response.json#'
     Entry Title       = 'List Namespaces'
-    Entry Description = 'List the namespaces immediately under a given namespace. This end-point
-list up to 1000 namespaces. If more namespaces are present a
+    Entry Description = 'List the namespaces immediately under a given namespace.
+
+This endpoint
+lists up to 1000 namespaces. If more namespaces are present, a
 `continuationToken` will be returned, which can be given in the next
 request. For the initial request, the payload should be an empty JSON
-object.
-
-**Remark**, this end-point is designed for humans browsing for tasks, not
-services, as that makes little sense.'
+object.'
 Entry 2     =
     Entry Type        = 'function'
     Entry Method      = 'post'
@@ -4788,8 +4790,10 @@ Entry 2     =
     Entry Input       = 'http://schemas.taskcluster.net/index/v1/list-tasks-request.json#'
     Entry Output      = 'http://schemas.taskcluster.net/index/v1/list-tasks-response.json#'
     Entry Title       = 'List Tasks'
-    Entry Description = 'List the tasks immediately under a given namespace. This end-point
-list up to 1000 tasks. If more tasks are present a
+    Entry Description = 'List the tasks immediately under a given namespace.
+
+This endpoint
+lists up to 1000 tasks. If more tasks are present, a
 `continuationToken` will be returned, which can be given in the next
 request. For the initial request, the payload should be an empty JSON
 object.
@@ -4808,23 +4812,37 @@ Entry 3     =
     Entry Input       = 'http://schemas.taskcluster.net/index/v1/insert-task-request.json#'
     Entry Output      = 'http://schemas.taskcluster.net/index/v1/indexed-task-response.json#'
     Entry Title       = 'Insert Task into Index'
-    Entry Description = 'Insert a task into the index. Please see the introduction above, for how
-to index successfully completed tasks automatically, using custom routes.'
+    Entry Description = 'Insert a task into the index.  If the new rank is less than the existing rank
+at the given index path, the task is not indexed but the response is still 200 OK.
+
+Please see the introduction above for information
+about indexing successfully completed tasks automatically using custom routes.'
 Entry 4     =
     Entry Type        = 'function'
     Entry Method      = 'get'
-    Entry Route       = '/task/<namespace>/artifacts/<name>'
-    Entry Args        = '[namespace name]'
+    Entry Route       = '/task/<indexPath>/artifacts/<name>'
+    Entry Args        = '[indexPath name]'
     Entry Query        = '[]'
     Entry Name        = 'findArtifactFromTask'
     Entry Stability   = 'stable'
     Entry Scopes      = '[[queue:get-artifact:<name>]]'
     Entry Input       = ''
     Entry Output      = ''
     Entry Title       = 'Get Artifact From Indexed Task'
-    Entry Description = 'Find task by namespace and redirect to artifact with given `name`,
-if no task existing for the given namespace, this API end-point respond
-`404`.'
+    Entry Description = 'Find a task by index path and redirect to the artifact on the most recent
+run with the given `name`.
+
+Note that multiple calls to this endpoint may return artifacts from differen tasks
+if a new task is inserted into the index between calls. Avoid using this method as
+a stable link to multiple, connected files if the index path does not contain a
+unique identifier.  For example, the following two links may return unrelated files:
+* https://index.taskcluster.net/task/some-app.win64.latest.installer/artifacts/public/installer.exe`
+* https://index.taskcluster.net/task/some-app.win64.latest.installer/artifacts/public/debug-symbols.zip`
+
+This problem be remedied by including the revision in the index path or by bundling both
+installer and debug symbols into a single artifact.
+
+If no task exists for the given index path, this API end-point responds with 404.'
 Entry 5     =
     Entry Type        = 'function'
     Entry Method      = 'get'
@@ -5124,8 +5142,7 @@ Properties
           TypeName               = 'Expiration'
           SourceURL              = 'http://schemas.taskcluster.net/index/v1/list-tasks-response.json#/properties/tasks/items/properties/expires'
         Property 'namespace' =
-          Description            = 'Namespace of the indexed task, used to find the indexed task in the
-          index.
+          Description            = 'Index path of the task.
           '
           MaxLength              = '255'
           Title                  = 'Namespace'
@@ -5143,9 +5160,7 @@ Properties
           TypeName               = 'Rank'
           SourceURL              = 'http://schemas.taskcluster.net/index/v1/list-tasks-response.json#/properties/tasks/items/properties/rank'
         Property 'taskId' =
-          Description            = 'Unique task identifier, this is UUID encoded as
-          [URL-safe base64](http://tools.ietf.org/html/rfc4648#section-5) and
-          stripped of `=` padding.
+          Description            = 'Unique task identifier for the task currently indexed at `namespace`.
           '
           Pattern                = '^[A-Za-z0-9_-]{8}[Q-T][A-Za-z0-9_-][CGKOSWaeimquy26-][A-Za-z0-9_-]{10}[AQgw]$'
           Title                  = 'Task Identifier'