New MicroProfile OpenAPI pre-releases

[Arthur De Magalhaes]

Hey everyone,

Just to inform of some updates in the MP OpenAPI space:

- our first release candidate for MP OpenAPI 1.1 

- our first milestone release for MP OpenAPI 2.0

Both have been released on GitHub (https://github.com/eclipse/microprofile-open-api/releases), although I will edit with more info early next week, and both have been release into Maven Central - should be available shortly.  

Thanks,

Arthur

[Emily Jiang]

Hi Arthur,

Which release will be included in MP 2.2? Was it MP Open API 1.1? What are the difference between MP 1.1 and 2.0?

Thanks

Emily

[Emily Jiang]

Just to clarify: MP 1.1 and MP 2.0 => MP Open API 1.1 and MP Open API 2.0

[Arthur De Magalhaes]

Hi Emily,

MP OpenAPI 1.1 should be included in MP 2.2.    

MP OpenAPI 2.0 is our future release, where we will be making some breaking changes to the APIs.     

As far as I understand, the umbrella MP 1.X releases are for EE7 compatible sub-specs, whereas MP 2.X is for EE8 compatible sub-specs - which is different than the versioning used by the sub-spec themselves, where a 1.X -> 2.X change constitutes a breaking change, major update, etc, not particularly tied to an EE version.  

In our case, MP OpenAPI 1.1 supports EE8, and so will MP OpenAPI 2.0 in the future.  

Thx,

Arthur

[Emily Jiang]

Thanks Arthur!

I did mean to ask you the difference between Open API 1.1 and 2.0.

Do you have a list of break changes in MP Open API 2.0? Do you want to trigger a umbrella release MP 3.0?

I think I will need to bring a discussion on the MP 2.x and 3.0 releases.

Thanks

Emily

[Jérémie Bresson]

Hi Emily,

The list of breaking changes in OpenAPI 2.0 are tracked in:
https://github.com/eclipse/microprofile-open-api/issues/251

For the moment it is mostly about changes to the interfaces in the "org.eclipse.microprofile.openapi.models.*" packages and removing methods deprecated in 1.x

Probably more features will be added to this list.

We need time until we do a release of OpenAPI 2.0. 

Consider this as a pre-release (in its early stages) until we know more.

Does a breaking change inside a MP project (like OpenAPI) force to create a new MP version (like 3.0 in this case)?

--
You received this message because you are subscribed to the Google Groups "Eclipse MicroProfile" group.
To unsubscribe from this group and stop receiving emails from it, send an email to microprofile...@googlegroups.com.
To post to this group, send email to microp...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/microprofile/ae281cb3-de69-4e74-9a91-42a5b24c0ad9%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Emily Jiang]

Hi Jeremie,

If backward incompatible changes are introduced in the current spec, which making the spec major version increase, e.g. updating Open API 1.1 -> Open API 2.0. The apps using Open API 1.1 no longer works on Open API 2.0, if Open API 2.0 is to be included in the umbrella spec, the umbrella spec major version needs to change, as per documented here.

Thanks

Emily

You received this message because you are subscribed to a topic in the Google Groups "Eclipse MicroProfile" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/microprofile/0mloDoeJ4ug/unsubscribe.
To unsubscribe from this group and all its topics, send an email to microprofile...@googlegroups.com.

To post to this group, send email to microp...@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/microprofile/CAKpOGDL3rYTJ3KKapa-df3J-dLrhrfGCYcH9py8ze8_YyktXew%40mail.gmail.com.

For more options, visit https://groups.google.com/d/optout.

--

Thanks
Emily
=================
Emily Jiang
eji...@apache.org

[Ken Finnigan]

A couple of things:

• MP 2.2 is also scheduled to add several other specifications at a version of 2.x from existing 1.x. These should all trigger a bump in MP umbrella spec version, not just OpenAPI.
• There is a note in that document on spec versioning where we provide leeway to discuss the umbrella versioning in the future if needed. I think it's needed.

To date MP umbrella spec versioning, including 2.x, has been purely Marketing driven. I think we need to continue that trend so we don't artificially inflate umbrella spec versions on, potentially, each release, or force sub specifications to only bump majors at the same time.

This needs to be discussed ASAP as it impacts the version number for February's release

Ken

To view this discussion on the web visit https://groups.google.com/d/msgid/microprofile/CAECq3A_WbcQga2M-%3D4tbYZJJS3EQAZAsjP8zrzim%3DK2f25kstw%40mail.gmail.com.

[Jérémie Bresson]

Hi Ken,

Just to be clear: 

in MP 2.2 (Umbrella) next February we plan to include OpenAPI 1.1, which contains no breaking change to the current 1.0.1.

OpenAPI is not impacted or is not impacting the February release.

For the moment MP-OpenAPI 2.0 is in its really early development stage.
As discussed in this thread, we have published a pre-release on Maven central called 2.0-MR1 (first milestone version), in order to have a released version on maven central (better than using always SNAPSHOTs).

https://github.com/eclipse/microprofile-open-api/releases/tag/mp-openapi-2.0-MR1

For the most common usage of MP-OpenAPI (which is adding OpenAPI capabilities to JAX-RS), our 1.x is the version to use.

The breaking changes introduced in the 2.0 stream are not really relevant for this use case.

We can wait with our OpenAPI 2.0 release until MP Umbrella is updating to 3.0.

I hope it makes sense.

Jeremie.

To view this discussion on the web visit https://groups.google.com/d/msgid/microprofile/CAKeeVe5sNqRXA1aJZiCZbKbnB5t4Jwu3Juep%3DFQwFaOqQTQ36A%40mail.gmail.com.

[Ken Finnigan]

Thanks for clarification Jeremie, though it's still an issue that needs discussing for MP 2.2

To view this discussion on the web visit https://groups.google.com/d/msgid/microprofile/CAKpOGDJ3CGbhvmKFapd9guUWfGTGNYncea1Sq%3DvC-MuPsw9P7A%40mail.gmail.com.

[Emily Jiang]

+1 Ken! We need to discuss the umbrella release version and socialise the sub-project releases re. major/minor.

Emily