Bug 1505402 - add new methods for specific schemas

* apiReferenceSchema
* exchangesReferenceSchema
* apiManifestSchema
* metadataMetaschema

Author: djmitche

README.md

@@ -32,6 +32,10 @@ root URL:
 * `docs(rootUrl, path)` -> `String`
 * `exchangeReference(rootUrl, service, version)` -> `String`
 * `schema(rootUrl, service, schema)` -> `String`
+* `apiManifestSchema(rootUrl, version)` -> `String`
+* `apiReferenceSchema(rootUrl, version)` -> `String`
+* `exchangesReferenceSchema(rootUrl, version)` -> `String`
+* `metadataMetaschema(rootUrl)` -> `String`
 * `ui(rootUrl, path)` -> `String`
 * `apiManifest(rootUrl)` -> `String`
 * `testRootUrl()` -> `String`
@@ -103,6 +107,10 @@ func APIReference(rootURL string, service string, version string) string
 func Docs(rootURL string, path string) string
 func ExchangeReference(rootURL string, service string, version string) string
 func Schema(rootURL string, service string, name string) string
+func APIManifestSchema(rootURL string, version string) string
+func APIReferenceSchema(rootURL string, version string) string
+func ExchangesReferenceSchema(rootURL string, version string) string
+func MetadataMetaschema(rootURL string) string
 func UI(rootURL string, path string) string
 func APIManifest(rootURL string) string
 ```
@@ -129,6 +137,10 @@ import taskcluster_urls
 
 taskcluster_urls.api(root_url, 'auth', 'v1', 'foo/bar')
 taskcluster_urls.schema(root_url, 'auth', 'v1/foo.yml') # Note that schema names have versions in them
+taskcluster_urls.api_manifest_schema(root_url, 'v1')
+taskcluster_urls.api_reference_schema(root_url, 'v1')
+taskcluster_urls.exchanges_reference_schema(root_url, 'v1')
+taskcluster_urls.metadata_metaschema(root_url, 'v1')
 taskcluster_urls.api_reference(root_url, 'auth', 'v1')
 taskcluster_urls.exchange_reference(root_url, 'auth', 'v1')
 taskcluster_urls.ui(root_url, 'foo/bar')
@@ -183,6 +195,10 @@ import org.mozilla.taskcluster.urls.*;
 
     String fooBarAPI        = urlProvider.api("auth", "v1", "foo/bar");
     String fooSchema        = urlProvider.schema("auth", "v1/foo.yml"); // Note that schema names have versions in them
+    String apiSchema        = urlProvider.apiReferenceSchema("v1");
+    String exchangesSchema  = urlProvider.exchangesReferenceSchema("v1");
+    String manifestSchema   = urlProvider.apiManifestSchema("v1");
+    String metaschema       = urlProvider.metadataMetaschema();
     String authAPIRef       = urlProvider.apiReference("auth", "v1");
     String authExchangesRef = urlProvider.exchangeReference("auth", "v1");
     String uiFooBar         = urlProvider.ui("foo/bar");

docs/urls-spec.md

@@ -24,6 +24,10 @@ Taskcluster uses URLs with the following pattern:
 | docs(rootUrl, path) | `<rootUrl>/docs/<path>` |
 | exchangeReference(rootUrl, service, version) | `<rootUrl>/references/<service>/<version>/exchanges.json` |
 | schema(rootUrl, service, schema) | `<rootUrl>/schemas/<service>/<schema>` |
+| apiSchema(rootUrl, version) | `<rootUrl>/schemas/common/api-reference-<version>.json` |
+| exchangesSchema(rootUrl, version) | `<rootUrl>/schemas/common/exchanges-reference-<version>.json` |
+| apiManifestSchema(rootUrl, version) | `<rootUrl>/schemas/common/manifest-<version>.json` |
+| metadataMchema(rootUrl) | `<rootUrl>/schemas/common/metadata-metaschema.json` |
 | ui(rootUrl, path) | `<rootUrl>/<path>` |
 | apiManifest(rootUrl) | `<rootUrl>/references/manifest.json` |
 

src/index.js

@@ -44,6 +44,34 @@ class LegacyUrls {
     return `https://schemas.taskcluster.net/${service}/${cleanPath(schema)}`;
   }
 
+  /**
+   * Generate URL for the api reference schema
+   */
+  apiReferenceSchema(version) {
+    return this.schema('common', `api-reference-${version}.json`);
+  }
+
+  /**
+   * Generate URL for the exchanges reference schema
+   */
+  exchangesReferenceSchema(version) {
+    return this.schema('common', `exchanges-reference-${version}.json`);
+  }
+
+  /**
+   * Generate URL for the api manifest schema
+   */
+  apiManifestSchema(version) {
+    return this.schema('common', `manifest-${version}.json`);
+  }
+
+  /**
+   * Generate URL for the metadata metaschema
+   */
+  metadataMetaschema() {
+    return this.schema('common', 'metadata-metaschema.json');
+  }
+
   /**
    * Generate URL for Taskcluser UI.
    */
@@ -100,6 +128,34 @@ class Urls {
     return `${this.rootUrl}/schemas/${service}/${cleanPath(schema)}`;
   }
 
+  /**
+   * Generate URL for the api reference schema
+   */
+  apiReferenceSchema(version) {
+    return this.schema('common', `api-reference-${version}.json`);
+  }
+
+  /**
+   * Generate URL for the exchanges reference schema
+   */
+  exchangesReferenceSchema(version) {
+    return this.schema('common', `exchanges-reference-${version}.json`);
+  }
+
+  /**
+   * Generate URL for the api manifest schema
+   */
+  apiManifestSchema(version) {
+    return this.schema('common', `manifest-${version}.json`);
+  }
+
+  /**
+   * Generate URL for the metadata metaschema
+   */
+  metadataMetaschema() {
+    return this.schema('common', 'metadata-metaschema.json');
+  }
+
   /**
    * Generate URL for Taskcluser UI.
    */
@@ -174,6 +230,34 @@ module.exports = {
     return withRootUrl(rootUrl).schema(service, version, schema);
   },
 
+  /**
+   * Generate URL for the api reference schema
+   */
+  apiReferenceSchema(rootUrl, version) {
+    return withRootUrl(rootUrl).apiReferenceSchema(version);
+  },
+
+  /**
+   * Generate URL for the exchanges reference schema
+   */
+  exchangesReferenceSchema(rootUrl, version) {
+    return withRootUrl(rootUrl).exchangesReferenceSchema(version);
+  },
+
+  /**
+   * Generate URL for the api manifest schema
+   */
+  apiManifestSchema(rootUrl, version) {
+    return withRootUrl(rootUrl).apiManifestSchema(version);
+  },
+
+  /**
+   * Generate URL for the metadata metaschema
+   */
+  metadataMetaschema(rootUrl) {
+    return withRootUrl(rootUrl).metadataMetaschema();
+  },
+
   /**
    * Generate URL for Taskcluser UI. The purpose of the function is to switch on rootUrl:
    * "The driver for having a ui method is so we can just call ui with a path and any root url, 

src/main/java/org/mozilla/taskcluster/urls/LegacyURLs.java

@@ -41,6 +41,34 @@ public String schema(String service, String schema) {
         return "https://schemas.taskcluster.net/" + service + "/" + Clean.path(schema);
     }
 
+    /**
+     * Generate URL for the api reference schema
+     */
+    public String apiReferenceSchema(String version) {
+        return schema("common", "api-reference-" + version + ".json");
+    }
+
+    /**
+     * Generate URL for the exchanges reference schema
+     */
+    public String exchangesReferenceSchema(String version) {
+        return schema("common", "exchanges-reference-" + version + ".json");
+    }
+
+    /**
+     * Generate URL for the api manifest schema
+     */
+    public String apiManifestSchema(String version) {
+        return schema("common", "manifest-" + version + ".json");
+    }
+
+    /**
+     * Generate URL for the metadata metaschema
+     */
+    public String metadataMetaschema() {
+        return schema("common", "metadata-metaschema.json");
+    }
+
     /**
      * Generate URL for Taskcluser UI.
      */

src/main/java/org/mozilla/taskcluster/urls/NewURLs.java

@@ -47,6 +47,34 @@ public String schema(String service, String schema) {
         return this.rootURL + "/schemas/" + service + "/" + Clean.path(schema);
     }
 
+    /**
+     * Generate URL for the api reference schema
+     */
+    public String apiReferenceSchema(String version) {
+        return schema("common", "api-reference-" + version + ".json");
+    }
+
+    /**
+     * Generate URL for the exchanges reference schema
+     */
+    public String exchangesReferenceSchema(String version) {
+        return schema("common", "exchanges-reference-" + version + ".json");
+    }
+
+    /**
+     * Generate URL for the api manifest schema
+     */
+    public String apiManifestSchema(String version) {
+        return schema("common", "manifest-" + version + ".json");
+    }
+
+    /**
+     * Generate URL for the metadata metaschema
+     */
+    public String metadataMetaschema() {
+        return schema("common", "metadata-metaschema.json");
+    }
+
     /**
      * Generate URL for Taskcluser UI.
      */

src/main/java/org/mozilla/taskcluster/urls/URLProvider.java

@@ -28,6 +28,26 @@ public interface URLProvider {
      */
     public String schema(String service, String schema);
 
+    /**
+     * Generate URL for the api reference schema
+     */
+    public String apiReferenceSchema(String version);
+
+    /**
+     * Generate URL for the exchanges reference schema
+     */
+    public String exchangesReferenceSchema(String version);
+
+    /**
+     * Generate URL for the api manifest schema
+     */
+    public String apiManifestSchema(String version);
+
+    /**
+     * Generate URL for the metadata metaschema
+     */
+    public String metadataMetaschema();
+
     /**
      * Generate URL for Taskcluser UI. The purpose of the function is to switch on rootUrl:
      * "The driver for having a ui method is so we can just call ui with a path and any root url, 

src/test/java/org/mozilla/taskcluster/urls/URLsTest.java

@@ -60,6 +60,14 @@ public static String testFunc(String function, URLProvider urlProvider, String[]
             return urlProvider.exchangeReference(args[0], args[1]);
         case "schema":
             return urlProvider.schema(args[0], args[1]);
+        case "apiReferenceSchema":
+            return urlProvider.apiReferenceSchema(args[0]);
+        case "exchangesReferenceSchema":
+            return urlProvider.exchangesReferenceSchema(args[0]);
+        case "apiManifestSchema":
+            return urlProvider.apiManifestSchema(args[0]);
+        case "metadataMetaschema":
+            return urlProvider.metadataMetaschema();
         case "ui":
             return urlProvider.ui(args[0]);
         case "apiManifest":

taskcluster_urls/__init__.py

@@ -43,6 +43,22 @@ def schema(root_url, service, name):
     else:
         return '{}/schemas/{}/{}'.format(root_url, service, name)
 
+def api_reference_schema(root_url, version):
+    """Generate URL for the api reference schema."""
+    return schema(root_url, 'common', 'api-reference-{}.json'.format(version))
+
+def exchanges_reference_schema(root_url, version):
+    """Generate URL for the exchanges reference schema."""
+    return schema(root_url, 'common', 'exchanges-reference-{}.json'.format(version))
+
+def api_manifest_schema(root_url, version):
+    """Generate URL for the api manifest schema"""
+    return schema(root_url, 'common', 'manifest-{}.json'.format(version))
+
+def metadata_metaschema(root_url, version):
+    """Generate URL for the metadata metaschema"""
+    return schema(root_url, 'common', 'metadata-metaschema.json')
+
 def ui(root_url, path):
     """
     Generate URL for a path in the Taskcluster ui.

tcurls.go

@@ -60,6 +60,26 @@ func Schema(rootURL string, service string, name string) string {
 	}
 }
 
+// APIReferenceSchema generates a url for the api reference schema
+func APIReferenceSchema(rootURL string, version string) string {
+	return Schema(rootURL, "common", fmt.Sprintf("api-reference-%s.json", version))
+}
+
+// ExchangesReferenceSchema generates a url for the exchanges reference schema
+func ExchangesReferenceSchema(rootURL string, version string) string {
+	return Schema(rootURL, "common", fmt.Sprintf("exchanges-reference-%s.json", version))
+}
+
+// APIManifestSchema generates a url for the api manifest schema
+func APIManifestSchema(rootURL string, version string) string {
+	return Schema(rootURL, "common", fmt.Sprintf("manifest-%s.json", version))
+}
+
+// MetadataMetaschema generates a url for the metadata metaschema
+func MetadataMetaschema(rootURL string) string {
+	return Schema(rootURL, "common", "metadata-metaschema.json")
+}
+
 // UI generates a url for a page in taskcluster tools site
 // The purpose of the function is to switch on rootUrl:
 // "The driver for having a ui method is so we can just call ui with a path and any root url,

tcurls_test.go

@@ -32,6 +32,14 @@ func testFunc(t *testing.T, function string, expectedURL string, root string, ar
 		actualURL = ExchangeReference(root, args[0], args[1])
 	case "schema":
 		actualURL = Schema(root, args[0], args[1])
+	case "apiReferenceSchema":
+		actualURL = APIReferenceSchema(root, args[0])
+	case "exchangesReferenceSchema":
+		actualURL = ExchangesReferenceSchema(root, args[0])
+	case "apiManifestSchema":
+		actualURL = APIManifestSchema(root, args[0])
+	case "metadataMetaschema":
+		actualURL = MetadataMetaschema(root)
 	case "ui":
 		actualURL = UI(root, args[0])
 	case "apiManifest":