Merge pull request #22 from djmitche/bug1505402

Bug 1505402 - RFC128 updates

Author: djmitche

README.md

@@ -32,8 +32,12 @@ 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`
-* `servicesManifest(rootUrl)` -> `String`
+* `apiManifest(rootUrl)` -> `String`
 * `testRootUrl()` -> `String`
 * `withRootUrl(rootUrl)` -> `Class` instance for above methods
 
@@ -52,7 +56,7 @@ libUrls.schema(rootUrl, 'auth', 'v1/foo.yml'); // Note that schema names have ve
 libUrls.apiReference(rootUrl, 'auth', 'v1');
 libUrls.exchangeReference(rootUrl, 'auth', 'v1');
 libUrls.ui(rootUrl, 'foo/bar');
-libUrls.servicesManifest(rootUrl);
+libUrls.apiManifest(rootUrl);
 libUrls.docs(rootUrl, 'foo/bar');
 ```
 
@@ -67,7 +71,7 @@ urls.schema('auth', 'v1/foo.yml');
 urls.apiReference('auth', 'v1');
 urls.exchangeReference('auth', 'v1');
 urls.ui('foo/bar');
-urls.servicesManifest();
+urls.apiManifest();
 urls.docs('foo/bar');
 ```
 
@@ -103,8 +107,12 @@ 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 ServicesManifest(rootURL string) string
+func APIManifest(rootURL string) string
 ```
 
 Install with:
@@ -129,10 +137,14 @@ 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')
-taskcluster_urls.servicesManifest(root_url)
+taskcluster_urls.apiManifest(root_url)
 taskcluster_urls.docs(root_url, 'foo/bar')
 
 And for testing,
@@ -183,10 +195,14 @@ 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");
-    String servicesManifest = urlProvider.servicesManifest();
+    String apiManifest      = urlProvider.apiManifest();
     String docsFooBar       = urlProvider.docs("foo/bar");
 
 ...

docs/urls-spec.md

@@ -24,8 +24,12 @@ 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>` |
-| servicesManifest(rootUrl) | `<rootUrl>/references/manifest.json` |
+| apiManifest(rootUrl) | `<rootUrl>/references/manifest.json` |
 
 *NOTE*: you should *always* use this library to generate URLs, rather than
 hard-coding any of the above patterns.

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.
    */
@@ -54,7 +82,7 @@ class LegacyUrls {
   /**
    * Returns a URL for the service manifest of a taskcluster deployment.
    */
-  servicesManifest() {
+  apiManifest() {
     return 'https://references.taskcluster.net/manifest.json';
   }
 }
@@ -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.
    */
@@ -110,7 +166,7 @@ class Urls {
   /**
    * Returns a URL for the service manifest of a taskcluster deployment.
    */
-  servicesManifest() {
+  apiManifest() {
     return `${this.rootUrl}/references/manifest.json`;
   }
 }
@@ -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, 
@@ -195,8 +279,8 @@ module.exports = {
   /**
    * Returns a URL for the service manifest of a taskcluster deployment.
    */
-  servicesManifest(rootUrl) {
-    return withRootUrl(rootUrl).servicesManifest();
+  apiManifest(rootUrl) {
+    return withRootUrl(rootUrl).apiManifest();
   },
 
   /**

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.
      */
@@ -51,7 +79,7 @@ public String ui(String path) {
     /**
      * Returns a URL for the service manifest of a taskcluster deployment.
      */
-    public String servicesManifest() {
+    public String apiManifest() {
         return "https://references.taskcluster.net/manifest.json";
     }
 }

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.
      */
@@ -57,7 +85,7 @@ public String ui(String path) {
     /**
      * Returns a URL for the service manifest of a taskcluster deployment.
      */
-    public String servicesManifest() {
+    public String apiManifest() {
         return this.rootURL + "/references/manifest.json";
     }
 }

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, 
@@ -43,5 +63,5 @@ public interface URLProvider {
     /**
      * Returns a URL for the service manifest of a taskcluster deployment.
      */
-    public String servicesManifest();
+    public String apiManifest();
 }

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

@@ -60,10 +60,18 @@ 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 "servicesManifest":
-            return urlProvider.servicesManifest();
+        case "apiManifest":
+            return urlProvider.apiManifest();
         default:
             throw new NoSuchMethodException("Unknown function type: " + function);
         }