@teemill/schema 0.2.3 → 0.2.4

package/README.md

@@ -1,4 +1,4 @@
-## @teemill/schema@0.2.3
+## @teemill/schema@0.2.4
 
 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.3 --save
+npm install @teemill/schema@0.2.4 --save
 ```
 
 _unPublished (not recommended):_
@@ -44,3 +44,43 @@ _unPublished (not recommended):_
 ```
 npm install PATH_TO_GENERATED_PACKAGE --save
 ```
+
+### Documentation for API Endpoints
+
+All URIs are relative to *https://localhost:8080/v1/schema*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*ApisApi* | [**getApi**](docs/ApisApi.md#getapi) | **GET** /{api} | Get api
+*ApisApi* | [**listApis**](docs/ApisApi.md#listapis) | **GET** / | List apis
+
+
+### Documentation For Models
+
+ - [Api](docs/Api.md)
+ - [ApiEndpointsInner](docs/ApiEndpointsInner.md)
+ - [ApiError](docs/ApiError.md)
+ - [Apis](docs/Apis.md)
+ - [ValidationError](docs/ValidationError.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="api-key"></a>
+### api-key
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
+
+<a id="session-oauth"></a>
+### session-oauth
+
+- **Type**: OAuth
+- **Flow**: password
+- **Authorization URL**: 
+- **Scopes**: N/A
+

package/api.ts

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

package/base.ts

@@ -4,7 +4,7 @@
  * Schema API
  * View PodOS API Schemas
  *
- * The version of the OpenAPI document: 0.2.3
+ * The version of the OpenAPI document: 0.2.4
  * 
  *
  * 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.3
+ * The version of the OpenAPI document: 0.2.4
  * 
  *
  * 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.3
+ * The version of the OpenAPI document: 0.2.4
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -89,7 +89,12 @@ export class Configuration {
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
-        this.baseOptions = param.baseOptions;
+        this.baseOptions = {
+            ...param.baseOptions,
+            headers: {
+                ...param.baseOptions?.headers,
+            },
+        };
         this.formDataCtor = param.formDataCtor;
     }
 

package/dist/api.d.ts

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

package/dist/api.js

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

package/dist/base.d.ts

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

package/dist/base.js

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

package/dist/common.d.ts

@@ -2,7 +2,7 @@
  * Schema API
  * View PodOS API Schemas
  *
- * The version of the OpenAPI document: 0.2.3
+ * The version of the OpenAPI document: 0.2.4
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
  *
  * @export
  */
-export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/dist/common.js

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

package/dist/configuration.d.ts

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

package/dist/configuration.js

@@ -5,7 +5,7 @@
  * Schema API
  * View PodOS API Schemas
  *
- * The version of the OpenAPI document: 0.2.3
+ * The version of the OpenAPI document: 0.2.4
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,13 +16,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Configuration = void 0;
 class Configuration {
     constructor(param = {}) {
+        var _a;
         this.apiKey = param.apiKey;
         this.username = param.username;
         this.password = param.password;
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
-        this.baseOptions = param.baseOptions;
+        this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
         this.formDataCtor = param.formDataCtor;
     }
     /**

package/dist/esm/api.d.ts

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

package/dist/esm/api.js

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

package/dist/esm/base.d.ts

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

package/dist/esm/base.js

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

package/dist/esm/common.d.ts

@@ -2,7 +2,7 @@
  * Schema API
  * View PodOS API Schemas
  *
- * The version of the OpenAPI document: 0.2.3
+ * The version of the OpenAPI document: 0.2.4
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
  *
  * @export
  */
-export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/dist/esm/common.js

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

package/dist/esm/configuration.d.ts

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

package/dist/esm/configuration.js

@@ -4,7 +4,7 @@
  * Schema API
  * View PodOS API Schemas
  *
- * The version of the OpenAPI document: 0.2.3
+ * The version of the OpenAPI document: 0.2.4
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,13 +13,14 @@
  */
 export class Configuration {
     constructor(param = {}) {
+        var _a;
         this.apiKey = param.apiKey;
         this.username = param.username;
         this.password = param.password;
         this.accessToken = param.accessToken;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
-        this.baseOptions = param.baseOptions;
+        this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
         this.formDataCtor = param.formDataCtor;
     }
     /**

package/dist/esm/index.d.ts

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

package/dist/esm/index.js

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

package/dist/index.d.ts

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

package/dist/index.js

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

package/docs/Api.md

@@ -0,0 +1,32 @@
+# Api
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**version** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+**endpoints** | [**Array<ApiEndpointsInner>**](ApiEndpointsInner.md) |  | [default to undefined]
+**schema** | **object** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Api } from '@teemill/schema';
+
+const instance: Api = {
+    id,
+    name,
+    description,
+    version,
+    updatedAt,
+    endpoints,
+    schema,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ApiEndpointsInner.md

@@ -0,0 +1,28 @@
+# ApiEndpointsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**method** | **string** |  | [default to undefined]
+**path** | **string** |  | [default to undefined]
+**tags** | **Array<string>** |  | [default to undefined]
+**internal** | **boolean** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ApiEndpointsInner } from '@teemill/schema';
+
+const instance: ApiEndpointsInner = {
+    name,
+    method,
+    path,
+    tags,
+    internal,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ApiError.md

@@ -0,0 +1,22 @@
+# ApiError
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ApiError } from '@teemill/schema';
+
+const instance: ApiError = {
+    code,
+    message,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Apis.md

@@ -0,0 +1,20 @@
+# Apis
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**apis** | [**Array<Api>**](Api.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Apis } from '@teemill/schema';
+
+const instance: Apis = {
+    apis,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ApisApi.md

@@ -0,0 +1,121 @@
+# ApisApi
+
+All URIs are relative to *https://localhost:8080/v1/schema*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getApi**](#getapi) | **GET** /{api} | Get api|
+|[**listApis**](#listapis) | **GET** / | List apis|
+
+# **getApi**
+> Api getApi()
+
+Get an API
+
+### Example
+
+```typescript
+import {
+    ApisApi,
+    Configuration
+} from '@teemill/schema';
+
+const configuration = new Configuration();
+const apiInstance = new ApisApi(configuration);
+
+let api: string; //API name (default to undefined)
+let project: string; //Project unique identifier (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getApi(
+    api,
+    project
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **api** | [**string**] | API name | defaults to undefined|
+| **project** | [**string**] | Project unique identifier | (optional) defaults to undefined|
+
+
+### Return type
+
+**Api**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully found api |  -  |
+|**400** | Failed validation |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listApis**
+> Apis listApis()
+
+List all available APIs
+
+### Example
+
+```typescript
+import {
+    ApisApi,
+    Configuration
+} from '@teemill/schema';
+
+const configuration = new Configuration();
+const apiInstance = new ApisApi(configuration);
+
+let project: string; //Project unique identifier (optional) (default to undefined)
+let search: string; //Search term used to filter results by name or identifier (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listApis(
+    project,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Project unique identifier | (optional) defaults to undefined|
+| **search** | [**string**] | Search term used to filter results by name or identifier | (optional) defaults to undefined|
+
+
+### Return type
+
+**Apis**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successfully listed apis |  -  |
+|**400** | Failed validation |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/ValidationError.md

@@ -0,0 +1,22 @@
+# ValidationError
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [default to undefined]
+**errors** | **{ [key: string]: Array<string>; }** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ValidationError } from '@teemill/schema';
+
+const instance: ValidationError = {
+    message,
+    errors,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/index.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teemill/schema",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "OpenAPI client for @teemill/schema",
   "author": "OpenAPI-Generator Contributors",
   "repository": {