Changes for page JsonRpcBundle

Last modified by Ashterix on 2024/07/11 13:11
From version 8.1
edited by Ashterix
on 2024/07/11 13:04
Change comment: There is no comment for this version
To version 10.1
edited by Ashterix
on 2024/07/11 13:06
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -21,6 +21,49 @@
21 21  This package makes it easy to create an API using a JSON-RPC server for Symfony v.6.* and later. It is suitable for developers who want to quickly and efficiently integrate RPC functionality into their projects.
22 22  {{include reference="docs.JsonRpcBundle.changeLog.7\.0.WebHome"/}}
23 23  
24 +== Changes in 7.0 ==
25 +
26 +=== General Changes ===
27 +
28 +* Changed the API documentation format to support the [[OpenRpc>>https://spec.open-rpc.org/]] standard
29 +* The RPC server lifecycle now operates on [[events and listeners>>doc:docs.JsonRpcBundle.functionality.events.WebHome]].
30 +
31 +=== Configuration ===
32 +
33 +{{warning}}
34 +**WARNING!!!** The configuration has undergone significant changes and is not backward compatible with version 6. See the updated [[documentation>>doc:docs.JsonRpcBundle.config_v7.WebHome]]
35 +{{/warning}}
36 +
37 +* In the {{code language="none"}}security{{/code}} block, HTTP methods are no longer protected; actions (API calls and documentation separately) are protected instead.
38 +* The {{code language="none"}}docs{{/code}} block no longer includes the {{code language="none"}}response{{/code}} block; instead, all properties are now located at its level.
39 +* Deprecated parameters have been removed ({{code language="none"}}docs.response.json_schema{{/code}}).
40 +* New parameters added to the {{code language="none"}}docs{{/code}} block that are used in building the API documentation:
41 +** project_name
42 +** project_description
43 +** project_version
44 +
45 +
46 +== Changes in 7.0 ==
47 +
48 +=== General Changes ===
49 +
50 +* Changed the API documentation format to support the [[OpenRpc>>https://spec.open-rpc.org/]] standard
51 +* The RPC server lifecycle now operates on [[events and listeners>>doc:docs.JsonRpcBundle.functionality.events.WebHome]].
52 +
53 +=== Configuration ===
54 +
55 +{{warning}}
56 +**WARNING!!!** The configuration has undergone significant changes and is not backward compatible with version 6. See the updated [[documentation>>doc:docs.JsonRpcBundle.config_v7.WebHome]]
57 +{{/warning}}
58 +
59 +* In the {{code language="none"}}security{{/code}} block, HTTP methods are no longer protected; actions (API calls and documentation separately) are protected instead.
60 +* The {{code language="none"}}docs{{/code}} block no longer includes the {{code language="none"}}response{{/code}} block; instead, all properties are now located at its level.
61 +* Deprecated parameters have been removed ({{code language="none"}}docs.response.json_schema{{/code}}).
62 +* New parameters added to the {{code language="none"}}docs{{/code}} block that are used in building the API documentation:
63 +** project_name
64 +** project_description
65 +** project_version
66 +
24 24  == Key Benefits ==
25 25  
26 26  * **Ease of Integration**: Integrating this package into your project is extremely straightforward. You simply need to add a special interface to any existing class, and it will automatically gain the capability to handle JSON-RPC requests.
... ... @@ -28,6 +28,7 @@
28 28  * **Efficiency**: Thanks to the optimization of calls and the use of modern Symfony components, the package guarantees high performance when processing requests.
29 29  
30 30  {{include reference="docs.JsonRpcBundle.changeLog.7\.0.WebHome"/}}
74 +
31 31  {{include reference="docs.JsonRpcBundle.functionality.WebHome"/}}
32 32  
33 33