Skip to content

Commit cd8a984

Browse files
committed
docs: update with start of remote details
1 parent ba2cd23 commit cd8a984

File tree

2 files changed

+9
-15
lines changed

2 files changed

+9
-15
lines changed

README.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
[![Build status](https://travis-ci.org/Mermade/openapi-codegen.svg?branch=master)](https://travis-ci.org/Mermade/openapi-codegen)
44
[![Greenkeeper badge](https://badges.greenkeeper.io/Mermade/openapi-codegen.svg)](https://greenkeeper.io/)
55

6-
Experimental port of [swagger-codegen](https://github.com/swagger-api/swagger-codegen) templates to Node.js. This project was initially a 24-hour hackathon. The model adaptor code is entirely original and has been reverse-engineered from the existing documentation and template usage.
6+
Node.js-based codegen for OpenAPI documents. This project was initially a 24-hour hackathon. The local model adaptor code is entirely original and has been reverse-engineered from the existing documentation and template usage.
77

88
**Work in progress**
99

10-
Supports OpenAPI 3.0.x natively, and Swagger/OpenAPI 1.2 and 2.0 by internal conversion
10+
Supports OpenAPI 3.0.x natively, and Swagger/OpenAPI 1.2 and 2.0 by internal conversion. Node.js LTS versions are supported.
1111

1212
## Usage
1313

@@ -32,6 +32,8 @@ cg [options] {[path]configName} {openapi-definition}
3232
Options:
3333
--help Show help [boolean]
3434
--version Show version number [boolean]
35+
--filter Filter term to use with --list [string]
36+
--list List available templates for provider (og or sc) [string]
3537
-d, --debug Turn on debugging information in the model [boolean]
3638
-f, --flat Do not include config-name in output directory structure
3739
[boolean]
@@ -54,8 +56,6 @@ In this case, the generated code will be written to the `.out/nodejs` directory.
5456

5557
You can also load the OpenAPI definition from a URL.
5658

57-
If you are using Node 6.x or lower, please specify the `--harmony` flag.
58-
5959
### API
6060

6161
```javascript
@@ -66,15 +66,17 @@ renderer.main(definition,config,configName);
6666

6767
## Templates
6868

69-
Templates are taken directly from `swagger-codegen`. This project is also licensed under [Apache-2.0](LICENSE) for this reason. Generated code is explicitly covered by the [Unlicense](templates/_common/UNLICENSE). Code to downconvert OpenAPI 3.0 definitions is taken from [Angular-Swagger-UI](https://github.com/Orange-OpenSource/angular-swagger-ui) and is MIT licensed.
69+
The local templates were taken directly from `swagger-codegen`. This project is also licensed under [Apache-2.0](LICENSE) for this reason. Generated code is explicitly covered by the [Unlicense](templates/_common/UNLICENSE). Code to downconvert OpenAPI 3.0 definitions is taken from [Angular-Swagger-UI](https://github.com/Orange-OpenSource/angular-swagger-ui) and is MIT licensed.
70+
71+
You can also use the latest online templates from two providers: `og` ([openapi-generator](https://github.com/OpenAPITools/openapi-generator)) and `sc` ([swagger-codegen](https://github.com/swagger-api/swagger-codegen)). The `--list` and `--filter` options allow you to see which templates are available. Note that using the online templates involves sending your API definition to a remote server.
7072

7173
### Contributors
7274

7375
See [here](https://github.com/swagger-api/swagger-codegen#template-creator) for a partial list of template contributors.
7476

7577
### Status of the template configurations
7678

77-
The templates with a status have a working (if not necessarily tested) configuration in the **configs** directory.
79+
The local templates with a status have a working (if not necessarily tested) configuration in the **configs** directory. Contributions are welcomed from the community of new and updated configurations and template updates.
7880

7981
<details>
8082
<summary>Click here to expand...</summary>
@@ -177,11 +179,3 @@ These templates are examples of how features of OpenAPI Codegen may be used, and
177179

178180
* [See here](docs/README.md) - contributions welcome
179181

180-
## See also
181-
182-
These projects use their own template model, not that of `swagger-codegen`
183-
184-
* https://github.com/fmvilas/swagger-node-codegen
185-
* https://github.com/wcandillon/swagger-js-codegen
186-
* https://github.com/Cian-Chambliss/swagger-codegen-prepare
187-

docs/modelProperties.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,5 +156,5 @@
156156
|hasEnums|model|false||
157157
|vars|model|[array]||
158158
|isMapContainer|model|false|boolean - set to true when container is a map|
159-
|isArrayContainer|model|false|boolean - set to true when container is a array|
159+
|isArrayContainer|model|false|boolean - set to true when container is an array|
160160
|itemsComplexType|vars|OrderDetails|Stores the name of the model for array elements|

0 commit comments

Comments
 (0)