docs: added migration notice to docs

Author: gibahjoe

README.md

@@ -74,12 +74,15 @@ Annotate a dart class with @Openapi() annotation
 
 ```dart
 @Openapi(
-    additionalProperties:
-    AdditionalProperties(pubName: 'petstore_api', pubAuthor: 'Johnny dep'),
-    inputSpecFile: 'example/openapi-spec.yaml',
-    generatorName: Generator.dart,
-    outputDirectory: 'api/petstore_api')
-class Example {}
+  additionalProperties:
+  DioProperties(pubName: 'petstore_api', pubAuthor: 'Johnny dep..'),
+  inputSpec:
+  RemoteSpec(path: 'https://petstore3.swagger.io/api/v3/openapi.json'),
+  typeMappings: {'Pet': 'ExamplePet'},
+  generatorName: Generator.dio,
+  runSourceGenOnOutput: true,
+  outputDirectory: 'api/petstore_api',
+)
 ```
 
 Run
@@ -99,7 +102,8 @@ The api sdk will be generated in the folder specified in the annotation. See exa
 
 ## Next Generation
 
-There is some new functionality slated to be added to the generator. This version will have the ability to:
+As of version 5.0 of this library, there is some new functionality slated to be added to the generator. This version
+will have the ability to:
 
 - cache changes in the OAS spec
 - Rerun when there ares difference in the cached copy and current copy
@@ -118,25 +122,18 @@ New:
 
 ```dart
 @Openapi(
-    additionalProperties:
-    AdditionalProperties(pubName: 'petstore_api', pubAuthor: 'Johnny dep'),
-    inputSpecFile: 'example/openapi-spec.yaml',
-    generatorName: Generator.dart,
-    outputDirectory: 'api/petstore_api',
-    cachePath: 'some/preferred/directory/cache.json',
-    useNextGen: true
+  additionalProperties:
+  DioProperties(pubName: 'petstore_api', pubAuthor: 'Johnny dep..'),
+  inputSpec:
+  RemoteSpec(path: 'https://petstore3.swagger.io/api/v3/openapi.json'),
+  typeMappings: {'Pet': 'ExamplePet'},
+  generatorName: Generator.dio,
+  runSourceGenOnOutput: true,
+  outputDirectory: 'api/petstore_api',
 )
 class Example {}
 ```
 
-**IMPORTANT** With the new changes comes 2 new annotation properties:
-
-- useNextGen (boolean)
-    - Default: `false`
-- cachePath (String)
-    - Default: `.dart_tool/openapi-generator-cache.json`
-    - Must be a path to a `json` file.
-    - Can only be set when `useNextGen` is `true`
 
 ## Contributing
 

example/api/petstore_api/pubspec.yaml

@@ -7,7 +7,7 @@ environment:
   sdk: '>=2.15.0 <3.0.0'
 
 dependencies:
-  dio: '^5.0.0'
+  dio: '^5.2.0'
   one_of: '>=1.5.0 <2.0.0'
   one_of_serializer: '>=1.5.0 <2.0.0'
   built_value: '>=8.4.0 <9.0.0'

example/lib/main.dart

@@ -1,4 +1,4 @@
-// Openapi Generator last run: : 2023-10-01T09:26:15.827402
+// Openapi Generator last run: : 2024-01-16T01:49:21.940229
 import 'package:flutter/material.dart';
 import 'package:openapi_generator_annotations/openapi_generator_annotations.dart';
 
@@ -124,4 +124,4 @@ class _MyHomePageState extends State<MyHomePage> {
       ), // This trailing comma makes auto-formatting nicer for build methods.
     );
   }
-}
+}