Skip to content

Commit ad5d5f5

Browse files
authored
Add TOC and a new section in the migration guide (#174)
1 parent 31b9362 commit ad5d5f5

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

docs/migration-from-swagger-codegen.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,22 @@ OpenAPI Generator is a fork of `swagger-codegen` between version `2.3.1` and `2.
44
This community-driven version called "OpenAPI Generator" provides similar functionalities and can be used as drop-in replacement.
55
This guide explains the major differences in order to help you with the migration.
66

7+
8+
**Table of contents**
9+
10+
- [New docker images](#new-docker-images)
11+
- [New maven coordinates](#new-maven-coordinates)
12+
- [Changes in Maven Plugin](#changes-in-maven-plugin)
13+
- [New generators names](#new-generators-names)
14+
- [New parameters name](#new-parameters-name)
15+
- [Renamed Mustache Template Variables](#renamed-mustache-template-variables)
16+
- [Ignore file](#ignore-file)
17+
- [metadata-folder](#metadata-folder)
18+
- [New default values for the generated code](#new-default-values-for-the-generated-code)
19+
- [New fully qualified name for the classes](#new-fully-qualified-name-for-the-classes)
20+
- [Body parameter name](#body-parameter-name)
21+
- [Generators not yet fully migrated](#generators-not-yet-fully-migrated)
22+
723
### New docker images
824

925
The docker images are available on DockerHub: https://hub.docker.com/u/openapitools/
@@ -226,4 +242,14 @@ paths:
226242
```
227243
If your API client is using named parameters in the function call (e.g. Perl required & optional parameters, Ruby optional parameters), you will need to add `x-codegen-request-body-name` to the spec to restore the original body parameter name.
228244

245+
# Generators not yet fully migrated
246+
247+
The following gnereators are not yet fully migrated and tested
248+
249+
- `rust-server`
250+
- `apex`
251+
252+
and we welcome contributions from the community to help with the migration
253+
254+
229255
[Back to OpenAPI-Generator's README page](../README.md)

0 commit comments

Comments
 (0)