Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MicroProfile Rest Client 4.0 ID #7624

Closed
jim-krueger opened this issue Oct 9, 2024 · 7 comments · Fixed by #7767
Closed

MicroProfile Rest Client 4.0 ID #7624

jim-krueger opened this issue Oct 9, 2024 · 7 comments · Fixed by #7767

Comments

@jim-krueger
Copy link
Member

jim-krueger commented Oct 9, 2024

REST clients page changes
The MicroProfile Rest Client section of the REST clients page requires the following updates for Microprofile Rest Client 4.0 as part of MicroProfile 7.0:

This is the current last paragraph:
If you update your server from an earlier version of the [MicroProfile REST Client](https://openliberty.io/docs/latest/reference/feature/mpRestClient.html) to version 3.0, changes in API behavior might require you to update your application code. For more information, see [Differences between MicroProfile REST Client 3.0 and 2.0](https://openliberty.io/docs/latest/reference/diff/mp-41-50-diff.html#rc).

Here is an updated version with recommended changes:
If you update your server from a version of the [MicroProfile REST Client](https://openliberty.io/docs/latest/reference/feature/mpRestClient.html) prior to version 3.0 to version 3.0 or higher, changes in API behavior might require you to update your application code. For more information, see [Differences between MicroProfile REST Client 3.0 and 2.0](https://openliberty.io/docs/latest/reference/diff/mp-41-50-diff.html#rc).

In addition, If you update your server to version 4.0 of the [MicroProfile REST Client](https://openliberty.io/docs/latest/reference/feature/mpRestClient.html), see [Differences between MicroProfile REST Client 4.0 and 3.0]().. <This will need a URL when #7610 is completed>

MicroProfile Rest Client page changes

. jsonp-2.1
. mpConfig-3.1
  • Add microProfile-7.0 to the "Platform Versions" and "Features that enable this feature" sections
  • Change"Developing a feature that depends on this feature" section to list io.openliberty.mpRestClient-4.0 instead of 3.0.
@ramkumar-k-9286
Copy link
Contributor

Hi @jim-krueger

Suggested changes made to the page.

Draft link: https://docs-draft-openlibertyio.mqj6zf7jocq.us-south.codeengine.appdomain.cloud/docs/latest/rest-clients.html

Please review the same and add the Developer Reviewed label if you are satisfied with the changes.

Regards,
Ramkumar.

CC @dmuelle

@jim-krueger
Copy link
Member Author

Hi @ramkumar-k-9286
So far only the first changes I requested have. been made. Please see the second part:

MicroProfile Rest Client page changes

The URL for this page will need to change from https://openliberty.io/docs/latest/reference/feature/mpRestClient-3.0.html to https://openliberty.io/docs/latest/reference/feature/mpRestClient-4.0.html.
The title will need to add 4.0 to the front.
The "Enabling this feature" section need to change to indicate mpRestClient-4.0
The "Features that this feature enables" needs to change to list the following features (with appropriate url changes):
. jsonp-2.1
. mpConfig-3.1
Add microProfile-7.0 to the "Platform Versions" and "Features that enable this feature" sections
Change"Developing a feature that depends on this feature" section to list io.openliberty.mpRestClient-4.0 instead of 3.0.

@ramkumar-k-9286
Copy link
Contributor

ramkumar-k-9286 commented Nov 8, 2024

Hi @jim-krueger

Those feature pages are autogenerated and the MPRC 4.0 page will be available after sometime between GM and GA and will include the details you are asking for without needing any manual edits from the docs team.

We can share the autogenerated page once it gets generated.

Regards,
Ramkumar

CC @dmuelle

@jim-krueger
Copy link
Member Author

@ramkumar-k-9286 Thanks. I have placed the label you requested. Thanks!

@dmuelle
Copy link
Member

dmuelle commented Nov 18, 2024

LGTM

@dmuelle
Copy link
Member

dmuelle commented Nov 19, 2024

Hi @jim-krueger - I notice in the main "Differences between.." topic, we are pointing to examples in the spec for multipart form data. Are there functional changes to multipart form data in MPRC 4.0? Or is it just new examples in the spec?

We have a topic about multipart form data: Send and receive multipart/form-data parts

Does this page need updates for MPRC 4.0? If the new examples in the spec are helpful, we should add them to this page.

@jim-krueger
Copy link
Member Author

jim-krueger commented Nov 19, 2024

Hi @dmuelle, Yes, for MPRC 4.0 these are just examples resulting from MPRC moving to the EE10 version of RESTful Web Services.

Also, yes, we probably should update Send and receive multipart/form-data parts, but I'd associate that more closely with RESTful Web Services 4.0, that will be part of EE11. Currently that document states:
In this version and later, this support is provided by the EntityPart API that is defined in the RESTful Web Services specification. For more information, see [section 3.5.2 of the Jakarta Restful Web Services specification].(https://jakarta.ee/specifications/restful-ws/3.1/jakarta-restful-ws-spec-3.1.html#consuming_multipart_formdata). which covers us until then.

Also, I think adding the examples from the spec here would be a fine thing to do if you want. The only advantage I can see to using the link instead is if the spec examples get changed in the future (something I don't expect will happen).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants