@teemill/schema 0.2.2 → 0.2.3

package/README.md

@@ -1,4 +1,4 @@
-## @teemill/schema@0.2.2
+## @teemill/schema@0.2.3
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @teemill/schema@0.2.2 --save
+npm install @teemill/schema@0.2.3 --save
 ```
 
 _unPublished (not recommended):_

package/api.ts

@@ -4,7 +4,7 @@
  * Schema API
  * View PodOS API Schemas
  *
- * The version of the OpenAPI document: 0.2.2
+ * The version of the OpenAPI document: 0.2.3
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -26,83 +26,120 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerM
 /**
  * 
  * @export
- * @interface ApiError
+ * @interface Api
  */
-export interface ApiError {
+export interface Api {
     /**
      * 
      * @type {string}
-     * @memberof ApiError
+     * @memberof Api
      */
-    'code'?: string;
+    'id': string;
     /**
      * 
      * @type {string}
-     * @memberof ApiError
+     * @memberof Api
      */
-    'message': string;
+    'name': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Api
+     */
+    'description': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Api
+     */
+    'version': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Api
+     */
+    'updatedAt': string;
+    /**
+     * 
+     * @type {Array<ApiEndpointsInner>}
+     * @memberof Api
+     */
+    'endpoints': Array<ApiEndpointsInner>;
+    /**
+     * 
+     * @type {object}
+     * @memberof Api
+     */
+    'schema'?: object;
 }
 /**
  * 
  * @export
- * @interface Schema
+ * @interface ApiEndpointsInner
  */
-export interface Schema {
+export interface ApiEndpointsInner {
     /**
      * 
      * @type {string}
-     * @memberof Schema
+     * @memberof ApiEndpointsInner
      */
-    'id': string;
+    'name': string;
     /**
      * 
      * @type {string}
-     * @memberof Schema
+     * @memberof ApiEndpointsInner
      */
-    'name': string;
+    'method': string;
     /**
      * 
      * @type {string}
-     * @memberof Schema
+     * @memberof ApiEndpointsInner
      */
-    'description': string;
+    'path': string;
     /**
      * 
-     * @type {string}
-     * @memberof Schema
+     * @type {Array<string>}
+     * @memberof ApiEndpointsInner
      */
-    'version': string;
+    'tags': Array<string>;
     /**
      * 
-     * @type {string}
-     * @memberof Schema
+     * @type {boolean}
+     * @memberof ApiEndpointsInner
      */
-    'updatedAt': string;
+    'internal': boolean;
+}
+/**
+ * 
+ * @export
+ * @interface ApiError
+ */
+export interface ApiError {
     /**
      * 
-     * @type {Array<string>}
-     * @memberof Schema
+     * @type {string}
+     * @memberof ApiError
      */
-    'paths': Array<string>;
+    'code'?: string;
     /**
      * 
-     * @type {object}
-     * @memberof Schema
+     * @type {string}
+     * @memberof ApiError
      */
-    'schema'?: object;
+    'message': string;
 }
 /**
  * 
  * @export
- * @interface Schemas
+ * @interface Apis
  */
-export interface Schemas {
+export interface Apis {
     /**
      * 
-     * @type {Array<Schema>}
-     * @memberof Schemas
+     * @type {Array<Api>}
+     * @memberof Apis
      */
-    'schemas': Array<Schema>;
+    'apis'?: Array<Api>;
 }
 /**
  * 
@@ -125,22 +162,22 @@ export interface ValidationError {
 }
 
 /**
- * SchemasApi - axios parameter creator
+ * ApisApi - axios parameter creator
  * @export
  */
-export const SchemasApiAxiosParamCreator = function (configuration?: Configuration) {
+export const ApisApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * Get an API schema
-         * @summary Get schema
+         * Get an API
+         * @summary Get api
          * @param {string} api API name
          * @param {string} [project] Project unique identifier
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getSchema: async (api: string, project?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        getApi: async (api: string, project?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'api' is not null or undefined
-            assertParamExists('getSchema', 'api', api)
+            assertParamExists('getApi', 'api', api)
             const localVarPath = `/{api}`
                 .replace(`{${"api"}}`, encodeURIComponent(String(api)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -177,14 +214,14 @@ export const SchemasApiAxiosParamCreator = function (configuration?: Configurati
             };
         },
         /**
-         * List all available schemas
-         * @summary List schemas
+         * List all available APIs
+         * @summary List apis
          * @param {string} [project] Project unique identifier
          * @param {string} [search] Search term used to filter results by name or identifier
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listSchemas: async (project?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        listApis: async (project?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             const localVarPath = `/`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -227,144 +264,144 @@ export const SchemasApiAxiosParamCreator = function (configuration?: Configurati
 };
 
 /**
- * SchemasApi - functional programming interface
+ * ApisApi - functional programming interface
  * @export
  */
-export const SchemasApiFp = function(configuration?: Configuration) {
-    const localVarAxiosParamCreator = SchemasApiAxiosParamCreator(configuration)
+export const ApisApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = ApisApiAxiosParamCreator(configuration)
     return {
         /**
-         * Get an API schema
-         * @summary Get schema
+         * Get an API
+         * @summary Get api
          * @param {string} api API name
          * @param {string} [project] Project unique identifier
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getSchema(api: string, project?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Schema>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getSchema(api, project, options);
+        async getApi(api: string, project?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Api>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getApi(api, project, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
-            const localVarOperationServerBasePath = operationServerMap['SchemasApi.getSchema']?.[localVarOperationServerIndex]?.url;
+            const localVarOperationServerBasePath = operationServerMap['ApisApi.getApi']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * List all available schemas
-         * @summary List schemas
+         * List all available APIs
+         * @summary List apis
          * @param {string} [project] Project unique identifier
          * @param {string} [search] Search term used to filter results by name or identifier
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listSchemas(project?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Schemas>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.listSchemas(project, search, options);
+        async listApis(project?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Apis>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listApis(project, search, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
-            const localVarOperationServerBasePath = operationServerMap['SchemasApi.listSchemas']?.[localVarOperationServerIndex]?.url;
+            const localVarOperationServerBasePath = operationServerMap['ApisApi.listApis']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
     }
 };
 
 /**
- * SchemasApi - factory interface
+ * ApisApi - factory interface
  * @export
  */
-export const SchemasApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
-    const localVarFp = SchemasApiFp(configuration)
+export const ApisApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = ApisApiFp(configuration)
     return {
         /**
-         * Get an API schema
-         * @summary Get schema
-         * @param {SchemasApiGetSchemaRequest} requestParameters Request parameters.
+         * Get an API
+         * @summary Get api
+         * @param {ApisApiGetApiRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getSchema(requestParameters: SchemasApiGetSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<Schema> {
-            return localVarFp.getSchema(requestParameters.api, requestParameters.project, options).then((request) => request(axios, basePath));
+        getApi(requestParameters: ApisApiGetApiRequest, options?: RawAxiosRequestConfig): AxiosPromise<Api> {
+            return localVarFp.getApi(requestParameters.api, requestParameters.project, options).then((request) => request(axios, basePath));
         },
         /**
-         * List all available schemas
-         * @summary List schemas
-         * @param {SchemasApiListSchemasRequest} requestParameters Request parameters.
+         * List all available APIs
+         * @summary List apis
+         * @param {ApisApiListApisRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listSchemas(requestParameters: SchemasApiListSchemasRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<Schemas> {
-            return localVarFp.listSchemas(requestParameters.project, requestParameters.search, options).then((request) => request(axios, basePath));
+        listApis(requestParameters: ApisApiListApisRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<Apis> {
+            return localVarFp.listApis(requestParameters.project, requestParameters.search, options).then((request) => request(axios, basePath));
         },
     };
 };
 
 /**
- * Request parameters for getSchema operation in SchemasApi.
+ * Request parameters for getApi operation in ApisApi.
  * @export
- * @interface SchemasApiGetSchemaRequest
+ * @interface ApisApiGetApiRequest
  */
-export interface SchemasApiGetSchemaRequest {
+export interface ApisApiGetApiRequest {
     /**
      * API name
      * @type {string}
-     * @memberof SchemasApiGetSchema
+     * @memberof ApisApiGetApi
      */
     readonly api: string
 
     /**
      * Project unique identifier
      * @type {string}
-     * @memberof SchemasApiGetSchema
+     * @memberof ApisApiGetApi
      */
     readonly project?: string
 }
 
 /**
- * Request parameters for listSchemas operation in SchemasApi.
+ * Request parameters for listApis operation in ApisApi.
  * @export
- * @interface SchemasApiListSchemasRequest
+ * @interface ApisApiListApisRequest
  */
-export interface SchemasApiListSchemasRequest {
+export interface ApisApiListApisRequest {
     /**
      * Project unique identifier
      * @type {string}
-     * @memberof SchemasApiListSchemas
+     * @memberof ApisApiListApis
      */
     readonly project?: string
 
     /**
      * Search term used to filter results by name or identifier
      * @type {string}
-     * @memberof SchemasApiListSchemas
+     * @memberof ApisApiListApis
      */
     readonly search?: string
 }
 
 /**
- * SchemasApi - object-oriented interface
+ * ApisApi - object-oriented interface
  * @export
- * @class SchemasApi
+ * @class ApisApi
  * @extends {BaseAPI}
  */
-export class SchemasApi extends BaseAPI {
+export class ApisApi extends BaseAPI {
     /**
-     * Get an API schema
-     * @summary Get schema
-     * @param {SchemasApiGetSchemaRequest} requestParameters Request parameters.
+     * Get an API
+     * @summary Get api
+     * @param {ApisApiGetApiRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof SchemasApi
+     * @memberof ApisApi
      */
-    public getSchema(requestParameters: SchemasApiGetSchemaRequest, options?: RawAxiosRequestConfig) {
-        return SchemasApiFp(this.configuration).getSchema(requestParameters.api, requestParameters.project, options).then((request) => request(this.axios, this.basePath));
+    public getApi(requestParameters: ApisApiGetApiRequest, options?: RawAxiosRequestConfig) {
+        return ApisApiFp(this.configuration).getApi(requestParameters.api, requestParameters.project, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**
-     * List all available schemas
-     * @summary List schemas
-     * @param {SchemasApiListSchemasRequest} requestParameters Request parameters.
+     * List all available APIs
+     * @summary List apis
+     * @param {ApisApiListApisRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof SchemasApi
+     * @memberof ApisApi
      */
-    public listSchemas(requestParameters: SchemasApiListSchemasRequest = {}, options?: RawAxiosRequestConfig) {
-        return SchemasApiFp(this.configuration).listSchemas(requestParameters.project, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
+    public listApis(requestParameters: ApisApiListApisRequest = {}, options?: RawAxiosRequestConfig) {
+        return ApisApiFp(this.configuration).listApis(requestParameters.project, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
     }
 }
 

package/base.ts

@@ -4,7 +4,7 @@
  * Schema API
  * View PodOS API Schemas
  *
- * The version of the OpenAPI document: 0.2.2
+ * The version of the OpenAPI document: 0.2.3
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/common.ts

@@ -4,7 +4,7 @@
  * Schema API
  * View PodOS API Schemas
  *
- * The version of the OpenAPI document: 0.2.2
+ * The version of the OpenAPI document: 0.2.3
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/configuration.ts

@@ -4,7 +4,7 @@
  * Schema API
  * View PodOS API Schemas
  *
- * The version of the OpenAPI document: 0.2.2
+ * The version of the OpenAPI document: 0.2.3
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).