Skip to content

Commit 225a412

Browse files
committed
api evolution
1 parent 2fd45ec commit 225a412

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

docs/modules/ROOT/pages/index.adoc

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,49 @@ the plugins will call `void run(Map<String, ?> options);` to run the processor,
4141

4242
- provide a `META-INF/services/io.openapiprocessor.api.OpenApiProcessor` property file in the resources with the class name of the implementing class.
4343

44+
== api evolution
45+
46+
[cols="5*",options="header"]
47+
|===
48+
| api version
49+
| package name
50+
| gradle plugin
51+
| maven plugin
52+
| description
53+
54+
| 2020.3 (1.3.0)
55+
| `io.openapiprocessor.api.v1.OpenApiProcessor`
56+
| yes
57+
| no
58+
a| unchanged
59+
60+
| 2020.3 (1.3.0)
61+
| `io.openapiprocessor.api.v1.Version`
62+
| no
63+
| no
64+
a| *experimental* to query a processor version
65+
66+
| 1.2.0
67+
| `io.openapiprocessor.api.v1.OpenApiProcessor`
68+
| yes
69+
| no
70+
a| better package name, no other changes
71+
72+
| 1.1.0
73+
| `io.openapiprocessor.api.OpenApiProcessor`
74+
| yes
75+
| no
76+
a| new package name
77+
78+
//4+| &darr; old (deprecated)
79+
80+
| 1.0.0
81+
| `com.github.hauner.openapi.api.OpenApiProcessor`
82+
| yes
83+
| yes
84+
a| old package name, still used by all processors
85+
86+
|===
4487

4588
== example implementations
4689

0 commit comments

Comments
 (0)