@rhoas/registry-management-sdk - npm Package Compare versions

Comparing version 0.0.2 to 0.1.0

dist/generated/api/default-api.d.ts

@@ -39,2 +39,9 @@ /**
     /**
+     *
+     * @summary Get the list of all registries.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRegistries: (options?: any) => Promise<RequestArgs>;
+    /**
      * Gets the details of a single instance of a `Registry`.
@@ -47,9 +54,2 @@ * @summary Get a Registry
     getRegistry: (registryId: number, options?: any) => Promise<RequestArgs>;
-    /**
-     *
-     * @summary Get the list of all registries.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listRegistries: (options?: any) => Promise<RequestArgs>;
 };
@@ -78,2 +78,9 @@ /**
     /**
+     *
+     * @summary Get the list of all registries.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRegistries(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Registry>>>;
+    /**
      * Gets the details of a single instance of a `Registry`.
@@ -86,9 +93,2 @@ * @summary Get a Registry
     getRegistry(registryId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Registry>>;
-    /**
-     *
-     * @summary Get the list of all registries.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listRegistries(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Registry>>>;
 };
@@ -117,2 +117,9 @@ /**
     /**
+     *
+     * @summary Get the list of all registries.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getRegistries(options?: any): AxiosPromise<Array<Registry>>;
+    /**
      * Gets the details of a single instance of a `Registry`.
@@ -125,9 +132,2 @@ * @summary Get a Registry
     getRegistry(registryId: number, options?: any): AxiosPromise<Registry>;
-    /**
-     *
-     * @summary Get the list of all registries.
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listRegistries(options?: any): AxiosPromise<Array<Registry>>;
 };
@@ -159,5 +159,4 @@ /**
     /**
-     * Gets the details of a single instance of a `Registry`.
-     * @summary Get a Registry
-     * @param {number} registryId A unique identifier for a &#x60;Registry&#x60;.
+     *
+     * @summary Get the list of all registries.
      * @param {*} [options] Override http request option.
@@ -167,6 +166,7 @@ * @throws {RequiredError}
      */
-    getRegistry(registryId: number, options?: any): AxiosPromise<Registry>;
+    getRegistries(options?: any): AxiosPromise<Array<Registry>>;
     /**
-     *
-     * @summary Get the list of all registries.
+     * Gets the details of a single instance of a `Registry`.
+     * @summary Get a Registry
+     * @param {number} registryId A unique identifier for a &#x60;Registry&#x60;.
      * @param {*} [options] Override http request option.
@@ -176,3 +176,3 @@ * @throws {RequiredError}
      */
-    listRegistries(options?: any): AxiosPromise<Array<Registry>>;
+    getRegistry(registryId: number, options?: any): AxiosPromise<Registry>;
 }
@@ -205,5 +205,4 @@ /**
     /**
-     * Gets the details of a single instance of a `Registry`.
-     * @summary Get a Registry
-     * @param {number} registryId A unique identifier for a &#x60;Registry&#x60;.
+     *
+     * @summary Get the list of all registries.
      * @param {*} [options] Override http request option.
@@ -213,6 +212,7 @@ * @throws {RequiredError}
      */
-    getRegistry(registryId: number, options?: any): Promise<import("axios").AxiosResponse<Registry>>;
+    getRegistries(options?: any): Promise<import("axios").AxiosResponse<Registry[]>>;
     /**
-     *
-     * @summary Get the list of all registries.
+     * Gets the details of a single instance of a `Registry`.
+     * @summary Get a Registry
+     * @param {number} registryId A unique identifier for a &#x60;Registry&#x60;.
      * @param {*} [options] Override http request option.
@@ -222,3 +222,3 @@ * @throws {RequiredError}
      */
-    listRegistries(options?: any): Promise<import("axios").AxiosResponse<Registry[]>>;
+    getRegistry(registryId: number, options?: any): Promise<import("axios").AxiosResponse<Registry>>;
 }

dist/generated/api/default-api.js

@@ -104,13 +104,9 @@ "use strict";
         /**
-         * Gets the details of a single instance of a `Registry`.
-         * @summary Get a Registry
-         * @param {number} registryId A unique identifier for a `Registry`.
+         *
+         * @summary Get the list of all registries.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getRegistry: (registryId, options = {}) => __awaiter(this, void 0, void 0, function* () {
-            // verify required parameter 'registryId' is not null or undefined
-            common_1.assertParamExists('getRegistry', 'registryId', registryId);
-            const localVarPath = `/api/serviceregistry_mgmt/v1/registries/{registryId}`
-                .replace(`{${"registryId"}}`, encodeURIComponent(String(registryId)));
+        getRegistries: (options = {}) => __awaiter(this, void 0, void 0, function* () {
+            const localVarPath = `/api/serviceregistry_mgmt/v1/registries`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -137,9 +133,13 @@ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
         /**
-         *
-         * @summary Get the list of all registries.
+         * Gets the details of a single instance of a `Registry`.
+         * @summary Get a Registry
+         * @param {number} registryId A unique identifier for a `Registry`.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listRegistries: (options = {}) => __awaiter(this, void 0, void 0, function* () {
-            const localVarPath = `/api/serviceregistry_mgmt/v1/registries`;
+        getRegistry: (registryId, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'registryId' is not null or undefined
+            common_1.assertParamExists('getRegistry', 'registryId', registryId);
+            const localVarPath = `/api/serviceregistry_mgmt/v1/registries/{registryId}`
+                .replace(`{${"registryId"}}`, encodeURIComponent(String(registryId)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -202,11 +202,10 @@ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
         /**
-         * Gets the details of a single instance of a `Registry`.
-         * @summary Get a Registry
-         * @param {number} registryId A unique identifier for a `Registry`.
+         *
+         * @summary Get the list of all registries.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getRegistry(registryId, options) {
+        getRegistries(options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getRegistry(registryId, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getRegistries(options);
                 return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
@@ -216,10 +215,11 @@ });
         /**
-         *
-         * @summary Get the list of all registries.
+         * Gets the details of a single instance of a `Registry`.
+         * @summary Get a Registry
+         * @param {number} registryId A unique identifier for a `Registry`.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listRegistries(options) {
+        getRegistry(registryId, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.listRegistries(options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getRegistry(registryId, options);
                 return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
@@ -259,2 +259,11 @@ });
         /**
+         *
+         * @summary Get the list of all registries.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getRegistries(options) {
+            return localVarFp.getRegistries(options).then((request) => request(axios, basePath));
+        },
+        /**
          * Gets the details of a single instance of a `Registry`.
@@ -269,11 +278,2 @@ * @summary Get a Registry
         },
-        /**
-         *
-         * @summary Get the list of all registries.
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        listRegistries(options) {
-            return localVarFp.listRegistries(options).then((request) => request(axios, basePath));
-        },
     };
@@ -312,5 +312,4 @@ };
     /**
-     * Gets the details of a single instance of a `Registry`.
-     * @summary Get a Registry
-     * @param {number} registryId A unique identifier for a `Registry`.
+     *
+     * @summary Get the list of all registries.
      * @param {*} [options] Override http request option.
@@ -320,8 +319,9 @@ * @throws {RequiredError}
      */
-    getRegistry(registryId, options) {
-        return exports.DefaultApiFp(this.configuration).getRegistry(registryId, options).then((request) => request(this.axios, this.basePath));
+    getRegistries(options) {
+        return exports.DefaultApiFp(this.configuration).getRegistries(options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     *
-     * @summary Get the list of all registries.
+     * Gets the details of a single instance of a `Registry`.
+     * @summary Get a Registry
+     * @param {number} registryId A unique identifier for a `Registry`.
      * @param {*} [options] Override http request option.
@@ -331,6 +331,6 @@ * @throws {RequiredError}
      */
-    listRegistries(options) {
-        return exports.DefaultApiFp(this.configuration).listRegistries(options).then((request) => request(this.axios, this.basePath));
+    getRegistry(registryId, options) {
+        return exports.DefaultApiFp(this.configuration).getRegistry(registryId, options).then((request) => request(this.axios, this.basePath));
     }
 }
 exports.DefaultApi = DefaultApi;

package.json

 {
   "name": "@rhoas/registry-management-sdk",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "description": "RHOAS Service Registry Management SDK",
@@ -24,4 +24,3 @@ "author": "Red Hat Developers",
     "build": "tsc --outDir dist/",
-    "prepublishOnly": "npm run build",
-    "publish": "npm publish"
+    "prepublishOnly": "npm run build"
   },
@@ -28,0 +27,0 @@ "dependencies": {

README.md

@@ -1,28 +0,7 @@
-## Service Registry Management
+## Service Registry Management SDK
 
-RHOAS Service Registry Management TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios).
-The generated Node module can be used in the following environments:
+RHOAS Service Registry Management TypeScript/JavaScript SDK.
 
-Environment
-
-- Node.js
-- Webpack
-- Browserify
-
-Language level
-
-- ES5 - you must have a Promises/A+ library installed
-- ES6
-
-Module system
-
-- CommonJS
-- ES6 module system
-
-It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html))
-
 ### Getting Started
 
-Navigate to the folder of your consuming project and run one of the following commands.
-
 #### Install Package
@@ -49,3 +28,3 @@
 
-registryApi.listRegistries().then((data) => {
+registryApi.getRegistries().then((data) => {
     console.log(data?.data)
@@ -59,2 +38,4 @@ }).catch((err) => {
 
+
+
 #### Security
@@ -61,0 +42,0 @@

src/generated/api/default-api.ts

@@ -114,13 +114,9 @@ /* tslint:disable */
         /**
-         * Gets the details of a single instance of a `Registry`.
-         * @summary Get a Registry
-         * @param {number} registryId A unique identifier for a `Registry`.
+         * 
+         * @summary Get the list of all registries.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getRegistry: async (registryId: number, options: any = {}): Promise<RequestArgs> => {
-            // verify required parameter 'registryId' is not null or undefined
-            assertParamExists('getRegistry', 'registryId', registryId)
-            const localVarPath = `/api/serviceregistry_mgmt/v1/registries/{registryId}`
-                .replace(`{${"registryId"}}`, encodeURIComponent(String(registryId)));
+        getRegistries: async (options: any = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/serviceregistry_mgmt/v1/registries`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -153,9 +149,13 @@ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
         /**
-         * 
-         * @summary Get the list of all registries.
+         * Gets the details of a single instance of a `Registry`.
+         * @summary Get a Registry
+         * @param {number} registryId A unique identifier for a &#x60;Registry&#x60;.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listRegistries: async (options: any = {}): Promise<RequestArgs> => {
-            const localVarPath = `/api/serviceregistry_mgmt/v1/registries`;
+        getRegistry: async (registryId: number, options: any = {}): Promise<RequestArgs> => {
+            // verify required parameter 'registryId' is not null or undefined
+            assertParamExists('getRegistry', 'registryId', registryId)
+            const localVarPath = `/api/serviceregistry_mgmt/v1/registries/{registryId}`
+                .replace(`{${"registryId"}}`, encodeURIComponent(String(registryId)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -220,20 +220,20 @@ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
         /**
-         * Gets the details of a single instance of a `Registry`.
-         * @summary Get a Registry
-         * @param {number} registryId A unique identifier for a &#x60;Registry&#x60;.
+         * 
+         * @summary Get the list of all registries.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getRegistry(registryId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Registry>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getRegistry(registryId, options);
+        async getRegistries(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Registry>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getRegistries(options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * 
-         * @summary Get the list of all registries.
+         * Gets the details of a single instance of a `Registry`.
+         * @summary Get a Registry
+         * @param {number} registryId A unique identifier for a &#x60;Registry&#x60;.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listRegistries(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Registry>>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.listRegistries(options);
+        async getRegistry(registryId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Registry>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getRegistry(registryId, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
@@ -272,2 +272,11 @@ },
         /**
+         * 
+         * @summary Get the list of all registries.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getRegistries(options?: any): AxiosPromise<Array<Registry>> {
+            return localVarFp.getRegistries(options).then((request) => request(axios, basePath));
+        },
+        /**
          * Gets the details of a single instance of a `Registry`.
@@ -282,11 +291,2 @@ * @summary Get a Registry
         },
-        /**
-         * 
-         * @summary Get the list of all registries.
-         * @param {*} [options] Override http request option.
-         * @throws {RequiredError}
-         */
-        listRegistries(options?: any): AxiosPromise<Array<Registry>> {
-            return localVarFp.listRegistries(options).then((request) => request(axios, basePath));
-        },
     };
@@ -322,5 +322,4 @@ };
     /**
-     * Gets the details of a single instance of a `Registry`.
-     * @summary Get a Registry
-     * @param {number} registryId A unique identifier for a &#x60;Registry&#x60;.
+     * 
+     * @summary Get the list of all registries.
      * @param {*} [options] Override http request option.
@@ -330,7 +329,8 @@ * @throws {RequiredError}
      */
-    getRegistry(registryId: number, options?: any): AxiosPromise<Registry>;
+    getRegistries(options?: any): AxiosPromise<Array<Registry>>;
 
     /**
-     * 
-     * @summary Get the list of all registries.
+     * Gets the details of a single instance of a `Registry`.
+     * @summary Get a Registry
+     * @param {number} registryId A unique identifier for a &#x60;Registry&#x60;.
      * @param {*} [options] Override http request option.
@@ -340,3 +340,3 @@ * @throws {RequiredError}
      */
-    listRegistries(options?: any): AxiosPromise<Array<Registry>>;
+    getRegistry(registryId: number, options?: any): AxiosPromise<Registry>;
 
@@ -377,5 +377,4 @@ }
     /**
-     * Gets the details of a single instance of a `Registry`.
-     * @summary Get a Registry
-     * @param {number} registryId A unique identifier for a &#x60;Registry&#x60;.
+     * 
+     * @summary Get the list of all registries.
      * @param {*} [options] Override http request option.
@@ -385,9 +384,10 @@ * @throws {RequiredError}
      */
-    public getRegistry(registryId: number, options?: any) {
-        return DefaultApiFp(this.configuration).getRegistry(registryId, options).then((request) => request(this.axios, this.basePath));
+    public getRegistries(options?: any) {
+        return DefaultApiFp(this.configuration).getRegistries(options).then((request) => request(this.axios, this.basePath));
     }
 
     /**
-     * 
-     * @summary Get the list of all registries.
+     * Gets the details of a single instance of a `Registry`.
+     * @summary Get a Registry
+     * @param {number} registryId A unique identifier for a &#x60;Registry&#x60;.
      * @param {*} [options] Override http request option.
@@ -397,5 +397,5 @@ * @throws {RequiredError}
      */
-    public listRegistries(options?: any) {
-        return DefaultApiFp(this.configuration).listRegistries(options).then((request) => request(this.axios, this.basePath));
+    public getRegistry(registryId: number, options?: any) {
+        return DefaultApiFp(this.configuration).getRegistry(registryId, options).then((request) => request(this.axios, this.basePath));
     }
 }

No alert changes

Worsened metrics

Total package byte prevSize

84730

decreased by-0.77%

Number of lines in readme file

43

decreased by-30.65%

No dependency changes