-
-
Notifications
You must be signed in to change notification settings - Fork 6.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[typescript] fixture: broken
Array<Array>
(#19548)
* [typescript] fixture: broken `Array<Array>` * Delete samples/client/others/typescript/builds/array-of-lists/models/L.ts * fix: remove incorrect mapping * chore: update generated code samples
- Loading branch information
Showing
32 changed files
with
1,601 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
generatorName: typescript | ||
outputDir: samples/client/others/typescript/builds/array-of-lists | ||
inputSpec: modules/openapi-generator/src/test/resources/3_0/typescript/array_list.yaml | ||
templateDir: modules/openapi-generator/src/main/resources/typescript |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
29 changes: 29 additions & 0 deletions
29
modules/openapi-generator/src/test/resources/3_0/typescript/array_list.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
openapi: 3.0.0 | ||
info: | ||
version: 1.0.0 | ||
title: Sample for Array of Lists | ||
paths: | ||
/list: | ||
get: | ||
operationId: list | ||
responses: | ||
200: | ||
description: OK | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '#/components/schemas/ListPaged' | ||
components: | ||
schemas: | ||
ListPaged: | ||
type: 'object' | ||
properties: | ||
data: | ||
type: 'array' | ||
items: | ||
$ref: '#/components/schemas/List' | ||
List: | ||
type: 'object' | ||
properties: | ||
id: | ||
type: 'integer' |
1 change: 1 addition & 0 deletions
1
samples/client/others/typescript/builds/array-of-lists/.gitignore
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
dist |
23 changes: 23 additions & 0 deletions
23
samples/client/others/typescript/builds/array-of-lists/.openapi-generator-ignore
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# OpenAPI Generator Ignore | ||
# Generated by openapi-generator https://github.com/openapitools/openapi-generator | ||
|
||
# Use this file to prevent files from being overwritten by the generator. | ||
# The patterns follow closely to .gitignore or .dockerignore. | ||
|
||
# As an example, the C# client generator defines ApiClient.cs. | ||
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: | ||
#ApiClient.cs | ||
|
||
# You can match any string of characters against a directory, file or extension with a single asterisk (*): | ||
#foo/*/qux | ||
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux | ||
|
||
# You can recursively match patterns against a directory, file or extension with a double asterisk (**): | ||
#foo/**/qux | ||
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux | ||
|
||
# You can also negate patterns with an exclamation (!). | ||
# For example, you can ignore all files in a docs folder with the file extension .md: | ||
#docs/*.md | ||
# Then explicitly reverse the ignore rule for a single file: | ||
#!docs/README.md |
25 changes: 25 additions & 0 deletions
25
samples/client/others/typescript/builds/array-of-lists/.openapi-generator/FILES
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
.gitignore | ||
DefaultApi.md | ||
README.md | ||
apis/DefaultApi.ts | ||
apis/baseapi.ts | ||
apis/exception.ts | ||
auth/auth.ts | ||
configuration.ts | ||
git_push.sh | ||
http/http.ts | ||
http/isomorphic-fetch.ts | ||
index.ts | ||
middleware.ts | ||
models/List.ts | ||
models/ListPaged.ts | ||
models/ObjectSerializer.ts | ||
models/all.ts | ||
package.json | ||
rxjsStub.ts | ||
servers.ts | ||
tsconfig.json | ||
types/ObjectParamAPI.ts | ||
types/ObservableAPI.ts | ||
types/PromiseAPI.ts | ||
util.ts |
1 change: 1 addition & 0 deletions
1
samples/client/others/typescript/builds/array-of-lists/.openapi-generator/VERSION
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
7.9.0-SNAPSHOT |
57 changes: 57 additions & 0 deletions
57
samples/client/others/typescript/builds/array-of-lists/DefaultApi.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
# .DefaultApi | ||
|
||
All URIs are relative to *http://localhost* | ||
|
||
Method | HTTP request | Description | ||
------------- | ------------- | ------------- | ||
[**list**](DefaultApi.md#list) | **GET** /list | | ||
|
||
|
||
# **list** | ||
> ListPaged list() | ||
|
||
### Example | ||
|
||
|
||
```typescript | ||
import { } from ''; | ||
import * as fs from 'fs'; | ||
|
||
const configuration = .createConfiguration(); | ||
const apiInstance = new .DefaultApi(configuration); | ||
|
||
let body:any = {}; | ||
|
||
apiInstance.list(body).then((data:any) => { | ||
console.log('API called successfully. Returned data: ' + data); | ||
}).catch((error:any) => console.error(error)); | ||
``` | ||
|
||
|
||
### Parameters | ||
This endpoint does not need any parameter. | ||
|
||
|
||
### Return type | ||
|
||
**ListPaged** | ||
|
||
### Authorization | ||
|
||
No authorization required | ||
|
||
### HTTP request headers | ||
|
||
- **Content-Type**: Not defined | ||
- **Accept**: application/json | ||
|
||
|
||
### HTTP response details | ||
| Status code | Description | Response headers | | ||
|-------------|-------------|------------------| | ||
**200** | OK | - | | ||
|
||
[[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) | ||
|
||
|
80 changes: 80 additions & 0 deletions
80
samples/client/others/typescript/builds/array-of-lists/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
## @ | ||
|
||
This generator creates TypeScript/JavaScript client that utilizes fetch-api. | ||
|
||
### Building | ||
|
||
To build and compile the typescript sources to javascript use: | ||
``` | ||
npm install | ||
npm run build | ||
``` | ||
|
||
### Publishing | ||
|
||
First build the package then run ```npm publish``` | ||
|
||
### Consuming | ||
|
||
Navigate to the folder of your consuming project and run one of the following commands. | ||
|
||
_published:_ | ||
|
||
``` | ||
npm install @ --save | ||
``` | ||
|
||
_unPublished (not recommended):_ | ||
|
||
``` | ||
npm install PATH_TO_GENERATED_PACKAGE --save | ||
``` | ||
|
||
### Usage | ||
|
||
Below code snippet shows exemplary usage of the configuration and the API based | ||
on the typical `PetStore` example used for OpenAPI. | ||
|
||
``` | ||
import * as your_api from 'your_api_package' | ||
// Covers all auth methods included in your OpenAPI yaml definition | ||
const authConfig: your_api.AuthMethodsConfiguration = { | ||
"api_key": "YOUR_API_KEY" | ||
} | ||
// Implements a simple middleware to modify requests before (`pre`) they are sent | ||
// and after (`post`) they have been received | ||
class Test implements your_api.Middleware { | ||
pre(context: your_api.RequestContext): Promise<your_api.RequestContext> { | ||
// Modify context here and return | ||
return Promise.resolve(context); | ||
} | ||
post(context: your_api.ResponseContext): Promise<your_api.ResponseContext> { | ||
return Promise.resolve(context); | ||
} | ||
} | ||
// Create configuration parameter object | ||
const configurationParameters = { | ||
httpApi: new your_api.JQueryHttpLibrary(), // Can also be ignored - default is usually fine | ||
baseServer: your_api.servers[0], // First server is default | ||
authMethods: authConfig, // No auth is default | ||
promiseMiddleware: [new Test()], | ||
} | ||
// Convert to actual configuration | ||
const config = your_api.createConfiguration(configurationParameters); | ||
// Use configuration with your_api | ||
const api = new your_api.PetApi(config); | ||
your_api.Pet p = new your_api.Pet(); | ||
p.name = "My new pet"; | ||
p.photoUrls = []; | ||
p.tags = []; | ||
p.status = "available"; | ||
Promise<your_api.Pet> createdPet = api.addPet(p); | ||
``` |
73 changes: 73 additions & 0 deletions
73
samples/client/others/typescript/builds/array-of-lists/apis/DefaultApi.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
// TODO: better import syntax? | ||
import {BaseAPIRequestFactory, RequiredError, COLLECTION_FORMATS} from './baseapi'; | ||
import {Configuration} from '../configuration'; | ||
import {RequestContext, HttpMethod, ResponseContext, HttpFile, HttpInfo} from '../http/http'; | ||
import {ObjectSerializer} from '../models/ObjectSerializer'; | ||
import {ApiException} from './exception'; | ||
import {canConsumeForm, isCodeInRange} from '../util'; | ||
import {SecurityAuthentication} from '../auth/auth'; | ||
|
||
|
||
import { ListPaged } from '../models/ListPaged'; | ||
|
||
/** | ||
* no description | ||
*/ | ||
export class DefaultApiRequestFactory extends BaseAPIRequestFactory { | ||
|
||
/** | ||
*/ | ||
public async list(_options?: Configuration): Promise<RequestContext> { | ||
let _config = _options || this.configuration; | ||
|
||
// Path Params | ||
const localVarPath = '/list'; | ||
|
||
// Make Request Context | ||
const requestContext = _config.baseServer.makeRequestContext(localVarPath, HttpMethod.GET); | ||
requestContext.setHeaderParam("Accept", "application/json, */*;q=0.8") | ||
|
||
|
||
|
||
const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default | ||
if (defaultAuth?.applySecurityAuthentication) { | ||
await defaultAuth?.applySecurityAuthentication(requestContext); | ||
} | ||
|
||
return requestContext; | ||
} | ||
|
||
} | ||
|
||
export class DefaultApiResponseProcessor { | ||
|
||
/** | ||
* Unwraps the actual response sent by the server from the response context and deserializes the response content | ||
* to the expected objects | ||
* | ||
* @params response Response returned by the server for a request to list | ||
* @throws ApiException if the response code was not in [200, 299] | ||
*/ | ||
public async listWithHttpInfo(response: ResponseContext): Promise<HttpInfo<ListPaged >> { | ||
const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]); | ||
if (isCodeInRange("200", response.httpStatusCode)) { | ||
const body: ListPaged = ObjectSerializer.deserialize( | ||
ObjectSerializer.parse(await response.body.text(), contentType), | ||
"ListPaged", "" | ||
) as ListPaged; | ||
return new HttpInfo(response.httpStatusCode, response.headers, response.body, body); | ||
} | ||
|
||
// Work around for missing responses in specification, e.g. for petstore.yaml | ||
if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) { | ||
const body: ListPaged = ObjectSerializer.deserialize( | ||
ObjectSerializer.parse(await response.body.text(), contentType), | ||
"ListPaged", "" | ||
) as ListPaged; | ||
return new HttpInfo(response.httpStatusCode, response.headers, response.body, body); | ||
} | ||
|
||
throw new ApiException<string | Blob | undefined>(response.httpStatusCode, "Unknown API Status Code!", await response.getBodyAsAny(), response.headers); | ||
} | ||
|
||
} |
37 changes: 37 additions & 0 deletions
37
samples/client/others/typescript/builds/array-of-lists/apis/baseapi.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
import { Configuration } from '../configuration' | ||
|
||
/** | ||
* | ||
* @export | ||
*/ | ||
export const COLLECTION_FORMATS = { | ||
csv: ",", | ||
ssv: " ", | ||
tsv: "\t", | ||
pipes: "|", | ||
}; | ||
|
||
|
||
/** | ||
* | ||
* @export | ||
* @class BaseAPI | ||
*/ | ||
export class BaseAPIRequestFactory { | ||
|
||
constructor(protected configuration: Configuration) { | ||
} | ||
}; | ||
|
||
/** | ||
* | ||
* @export | ||
* @class RequiredError | ||
* @extends {Error} | ||
*/ | ||
export class RequiredError extends Error { | ||
name: "RequiredError" = "RequiredError"; | ||
constructor(public api: string, public method: string, public field: string) { | ||
super("Required parameter " + field + " was null or undefined when calling " + api + "." + method + "."); | ||
} | ||
} |
15 changes: 15 additions & 0 deletions
15
samples/client/others/typescript/builds/array-of-lists/apis/exception.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
/** | ||
* Represents an error caused by an api call i.e. it has attributes for a HTTP status code | ||
* and the returned body object. | ||
* | ||
* Example | ||
* API returns a ErrorMessageObject whenever HTTP status code is not in [200, 299] | ||
* => ApiException(404, someErrorMessageObject) | ||
* | ||
*/ | ||
export class ApiException<T> extends Error { | ||
public constructor(public code: number, message: string, public body: T, public headers: { [key: string]: string; }) { | ||
super("HTTP-Code: " + code + "\nMessage: " + message + "\nBody: " + JSON.stringify(body) + "\nHeaders: " + | ||
JSON.stringify(headers)) | ||
} | ||
} |
Oops, something went wrong.