From 0a7d8c1adc9cfdf45e5b210c02876e17bd24ee45 Mon Sep 17 00:00:00 2001 From: "IMATIASL\\patricia.martinez" Date: Tue, 15 Apr 2025 18:19:14 +0200 Subject: [PATCH 1/9] Updating doc with JSON:API adapters --- .../components/jsonapi.md | 37 +++++++++++++++++++ .../components/report-store.md | 34 ++++++++++++++--- docs/guide/10-structure.md | 2 +- docs/guide/11-app-config.md | 22 ++++++----- 4 files changed, 79 insertions(+), 16 deletions(-) create mode 100644 docs/addons/ontimize_web_ngx_report/components/jsonapi.md diff --git a/docs/addons/ontimize_web_ngx_report/components/jsonapi.md b/docs/addons/ontimize_web_ngx_report/components/jsonapi.md new file mode 100644 index 000000000..729a1f2f6 --- /dev/null +++ b/docs/addons/ontimize_web_ngx_report/components/jsonapi.md @@ -0,0 +1,37 @@ +--- +title: "Report store" +permalink: /addons/report/components/report-store/jsonapi +layout: default +parent: Report store +grand_parent: Report +nav_order: 4 +--- +# Introduction +The *Report Store** system will allow you to store, manage and export all kinds of reports designed and implemented via the JasperReports API. This module will let you use your Ontimize application data as data sources for your reports, allowing you to fully customize its layout with tables, charts, graphs… and also visualize, export, print and download your reports. + + +# Previous concepts +* Report: It is the generic representation of a report. One report can have one or multiple custom report parameters, or have none. +* Main report file: The file containing all the information regarding the report layout, along with the data sources, connections and other configuration directives. Written in .jrxml format. +* Report parameter: It is the generic representation of a custom report parameter. They are used for defining filters, implementing pagination, or even specifying the report data source. + +# Steps +```ts + { + "REPORTUUID": string + "REPORTNAME": string + "REPORTTYPE": string + "REPORTDESCRIPTION": string + "REPORTFILENAME":string + + }; + { + REPORTPARAMETERID:number, INTEGER PRIMARY KEY AUTOINCREMENT, + REPORTPARAMETERNAME:string, + REPORTPARAMETERDESCRIPTION: string, + REPORTPARAMETERNESTEDTYPE: string, + REPORTPARAMETERVALUECLASS: string, + REPORTUUID:string + } + + diff --git a/docs/addons/ontimize_web_ngx_report/components/report-store.md b/docs/addons/ontimize_web_ngx_report/components/report-store.md index 6f3fe05a2..d3e0ec648 100644 --- a/docs/addons/ontimize_web_ngx_report/components/report-store.md +++ b/docs/addons/ontimize_web_ngx_report/components/report-store.md @@ -7,13 +7,35 @@ grand_parent: Addons nav_order: 3 --- +Report store supports **OntimizeEE** and **JSON:API** standards. + +{: .note} +>Remember, if you are implementing **OntimizeEE**, to complete the steps you need to perform on your backend server to complete the report store configuration following this [link](https://ontimize.github.io/ontimize-boot/basics/reports/report-store){:target="_blank"} + {: .note} ->Remember to complete the steps you need to perform on your backend server to complete the report store configuration following this [link](https://ontimize.github.io/ontimize-boot/basics/reports/report-store){:target="_blank"} +>Additionally, if you are implementing **JSON:API**, ensure your backend is configured accordingly by following the guidelines provided [here]({{ base_path }}/jsonapi){:target="_blank"} To add that in your application run a reports with jasper template you have to follow the following steps +1. To configure the report store service, you can configure the path in `servicesConfiguration`. +The default path for requests to +* **OntimizeEE** is `/reportstore` , +* **JSON:API** is `/Report` . + +```ts +export const SERVICE_CONFIG = +{ + 'reportoarameter': { + 'path': '/ReportParameter' + }, + 'reportstore': { + 'path': '/Report' + }, + ... +} +``` -1. To add new menu option `Reports` in `src/app/shared/app.menu.config.ts` +2. To add new menu option `Reports` in `src/app/shared/app.menu.config.ts` ```ts .. @@ -32,7 +54,7 @@ To add that in your application run a reports with jasper template you have to f } ``` -2. In `src/app/main/main-routing.module.ts`, add a route for new report management module p.e with `path` of `reports` +3. In `src/app/main/main-routing.module.ts`, add a route for new report management module p.e with `path` of `reports` ```ts import { NgModule } from '@angular/core'; @@ -58,7 +80,7 @@ To add that in your application run a reports with jasper template you have to f export class MainRoutingModule { } ``` -3. Create the new report management module `ReportModule` and import `OReportRoutingModule` module +4. Create the new report management module `ReportModule` and import `OReportRoutingModule` module ```ts import { NgModule } from '@angular/core'; @@ -78,7 +100,7 @@ To add that in your application run a reports with jasper template you have to f export class ReportModule{} ``` -4. To add/remove/update report +5. To add/remove/update report Now you should a new option similar to where you can management the reports @@ -92,7 +114,7 @@ To add that in your application run a reports with jasper template you have to f ![Detail report ]({{ "/assets/images/report/reportDetailStore.png" | absolute_url }}){: .comp-example-img} -5. Add a button and on its click event generate the PDF document. The method `openFillReport` takes as parameter the `UUID`, the parameters values and the filter of the report. +6. Add a button and on its click event generate the PDF document. The method `openFillReport` takes as parameter the `UUID`, the parameters values and the filter of the report. ```html diff --git a/docs/guide/10-structure.md b/docs/guide/10-structure.md index ccd83964b..018fbfdc5 100644 --- a/docs/guide/10-structure.md +++ b/docs/guide/10-structure.md @@ -57,7 +57,7 @@ ontimize-web-ngx-quickstart | | | ├── movement-types-renderer/ # Custom component (cell renderer) definition | | | |── style-manager/ # Class for managing stylesheets | | | |── app.menu.config.ts # Application menu definition -| | | |── app.services.config.ts # Ontimize JEE services path configuration file +| | | |── app.services.config.ts # Ontimize JEE or JSON:API services path configuration file | | | |── constant.ts # File used to store constant variables on the app like the primary color code | | | └── shared.modules.ts # Shared module definition | | | diff --git a/docs/guide/11-app-config.md b/docs/guide/11-app-config.md index 330b88c0b..25088df02 100644 --- a/docs/guide/11-app-config.md +++ b/docs/guide/11-app-config.md @@ -29,7 +29,7 @@ export const CONFIG: Config = { uuid: 'com.ontimize.web.quickstart', title: 'Ontimize Web QuickStart', locale: 'es', /* Optional */ - serviceType: 'Ontimize' | 'OntimizeEE',/* Optional */ + serviceType: 'Ontimize' | 'OntimizeEE' | 'JSONAPI',/* Optional, by default is OntimizeEE */ servicesConfiguration: SERVICE_CONFIG, appMenuConfiguration: MENU_CONFIG, applicationLocales: ['es', 'en'], @@ -66,11 +66,12 @@ The noteworthy parameters here are: - **uuid:** The application identifier, this is the unique package identifier of the application. It is used when storing or managing temporal data related with the application. By default is set as `ontimize-web-uuid`. - **title:** The title of the application. - **locale:** The language of the application specified by the country code (e.g. 'es' for Spanish, 'en' for English, etc.). -- **serviceType:** The service type used in the app by framework components that request data from server. You can specify Ontimize REST standard, Ontimize REST JEE or a custom implementation. - - **Not configured (by default):** if you do not configure or specify this parameter, the framework configures Ontimize REST standard services. - - **'Ontimize'(default):** string that configures Ontimize REST services. - - **'OntimizeEE':** string that configures Ontimize REST JEE services and is the default value. - - **Custom class:** a service class reference that extends `OntimizeService` or `OntimizeEEService` or implements the `IDataService` interface. More information [here]({{ base_path }}/guide/service/#extending-ontimize-web-services){:target="_blank"}. +- **serviceType:** The service type used in the app by framework components that request data from server. You can specify Ontimize REST standard, Ontimize REST JEE, JSON:API standard or a custom implementation. + - **Not configured (by default):** if you do not configure or specify this parameter, the framework configures OntimizeEE REST standard services. + - **'Ontimize'** string that configures Ontimize REST services. + - **'OntimizeEE'(default)::** string that configures Ontimize REST JEE services and is the default value. + - **'JSONAPI':** string that configures JSON:API REST services + - **Custom class:** a service class reference that extends `OntimizeService`, `OntimizeEEService`, `JSONAPI` or implements the `IDataService` interface. More information [here]({{ base_path }}/guide/service/#extending-ontimize-web-services){:target="_blank"}. - **servicesConfiguration:** Object that contains the services configuration parameters. Learn more [here](#services-configuration). - **appMenuConfiguration:** Object defining application menu structure. Learn more [here](#menu-configuration). - **applicationLocales:** Set of available locales for the application. @@ -311,9 +312,12 @@ You have to replace the references of "ontimize-web-ngx-jee-seed" by the name of # Services configuration -If you indicate in the application configuration that the application should use **OntimizeEE** services (check `serviceType` attribute in the [previous section](#application-configuration-file) of this page), you have to configure the service paths. For doing this **OntimizeWeb** uses the `servicesConfiguration` property from the app configuration file that must point to an object defined as in the example below. +Ontimize Web supports **OntimizeEE** and **JSON:API**, to configure this standards you need to specify it in the `servicesConfiguration` (check `serviceType` attribute in the [previous section](#application-configuration-file). + of this page). -In this object, the keys represents the different services names used in the application. Every service needs a `path` property where you must set the path of the service, excluding the URL configured in the `apiEndpoint` attribute of the application configuration. + If you indicate in the application configuration that the application should use **OntimizeEE** or **JSON:API** services, you have to configure the service paths. For doing this **OntimizeWeb** uses the `servicesConfiguration` property from the app configuration file which should reference an object structured as shown in the example below. + +In this object, each key represents a different service used in the application. Each service must include a `path` property, where you define the service's path—excluding the base URL specified in the apiEndpoint attribute of the application configuration. ```javascript export const SERVICE_CONFIG: Object = { @@ -338,7 +342,7 @@ export const SERVICE_CONFIG: Object = { }; ``` -For clarification, if your `apiEndpoint` is the one in the [application configuration](#application-configuration-file) example, **OntimizeWeb** will concat the `apiEndpoint` and the `path` of the service to build the URL for sending requests. For example : https://try.ontimize.com/QSAllComponents-jee/services/rest/customers. +For clarification, if your `apiEndpoint` is the one in the [application configuration](#application-configuration-file) example, **OntimizeWeb** and **JSON:API** will concat the `apiEndpoint` and the `path` of the service to build the URL for sending requests. For example : https://try.ontimize.com/QSAllComponents-jee/services/rest/customers. # Internationalization (i18) configuration From 22205ce423538494501c1f3ae8ccff6346f0ac75 Mon Sep 17 00:00:00 2001 From: "IMATIASL\\patricia.martinez" Date: Mon, 21 Apr 2025 11:21:23 +0200 Subject: [PATCH 2/9] Added nameConvention --- docs/guide/11-app-config.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/guide/11-app-config.md b/docs/guide/11-app-config.md index 25088df02..f5a6d9d9d 100644 --- a/docs/guide/11-app-config.md +++ b/docs/guide/11-app-config.md @@ -55,7 +55,8 @@ export const CONFIG: Config = { }, exportConfiguration: { path:'/export' - } + }, + nameConvention: 'upper' | 'lower' | 'database' /* Optional */ }; ``` {: .no-scroll} @@ -95,6 +96,11 @@ The noteworthy parameters here are: - **permissionsConfiguration:** permissions service configuration object. - **exportConfiguration**: export configuration object required only with `Ontimize Boot version 3.9.0 or above` - **path**: the export path used in the remote package query compatible. +- **nameConvention**: Indicates the naming format to which database column names will be transformed when exposed through REST API requests. + Column names will be converted to `upper`,`lower` or `database` + - `upper`: All letters in column names will be converted to uppercase (e.g., `USER_ID`). + - `lower`: All letters in column names will be converted to lowercase (e.g., `user_id`). + - `database`: Column names will be used as defined in the component configuration, without any transformation (e.g., `UserId` or `USER_ID`, depending on how they are stored). # Package.json configuration From ec491a0f5e3ec01c6da4233e52bc4763e1e67399 Mon Sep 17 00:00:00 2001 From: "IMATIASL\\patricia.martinez" Date: Mon, 21 Apr 2025 12:12:48 +0200 Subject: [PATCH 3/9] New input configure-service-args --- _data/components/common/attributes.yml | 11 ++++++++++- _data/components/form.yml | 3 ++- _data/components/grid.yml | 2 +- _data/components/list.yml | 2 +- _data/components/ocomboData/00combo.yml | 2 +- _data/components/olistpickerData/00listPicker.yml | 2 +- _data/components/otableData/00table.yml | 2 +- .../renderers/09tableColumnRendererService.yml | 2 ++ _data/components/overviewService.yml | 2 ++ _data/components/overviewchart.yml | 2 +- _data/components/radio.yml | 2 +- _data/components/service.yml | 2 +- _data/components/serviceBase.yml | 2 ++ 13 files changed, 26 insertions(+), 10 deletions(-) diff --git a/_data/components/common/attributes.yml b/_data/components/common/attributes.yml index 8fc45faad..68c15e189 100644 --- a/_data/components/common/attributes.yml +++ b/_data/components/common/attributes.yml @@ -465,5 +465,14 @@ default: "[10, 25, 50, 100]", required: "", description: "Page size options separated by ';'." - } + }, + "configure-service-args": { + name: "configure-service-args", + type: "OConfigureServiceArgs", + since: "15.6.0", + default: "no", + required: "", + description: "Allows configure service" + } + } diff --git a/_data/components/form.yml b/_data/components/form.yml index c386946e5..f40a197b1 100644 --- a/_data/components/form.yml +++ b/_data/components/form.yml @@ -185,7 +185,8 @@ attributes: [ type: "(data: any) => OFormValidation", since: "15.4.2", description: "Executes the before-save validation callback for insert and update operations." - +},{ + name: "configure-service-args" }] outputs: [{ diff --git a/_data/components/grid.yml b/_data/components/grid.yml index fdc18375c..e02f0c085 100644 --- a/_data/components/grid.yml +++ b/_data/components/grid.yml @@ -6,7 +6,7 @@ apiTitle: "OGridComponent" inheritedAttributes: [{ component: "OServiceBaseComponent", path: "components/service/service-base/api", - attributes: ["attr", "service", "service-type", "entity", "query-on-init", "query-fallback-function", "query-on-bind", "pageable", "columns", "keys", "parent-keys", "static-data", "query-method", "paginated-query-method", "query-rows", "store-state", "query-with-null-parent-keys"] + attributes: ["attr", "service", "service-type", "entity", "query-on-init", "query-fallback-function", "query-on-bind", "pageable", "columns", "keys", "parent-keys", "static-data", "query-method", "paginated-query-method", "query-rows", "store-state", "query-with-null-parent-keys", "configure-service-args"] },{ component: "OServiceComponent", path: "components/service/service/api", diff --git a/_data/components/list.yml b/_data/components/list.yml index f3262f1dc..8e5596494 100644 --- a/_data/components/list.yml +++ b/_data/components/list.yml @@ -5,7 +5,7 @@ apiTitle: "OListComponent" inheritedAttributes: [{ component: "OServiceBaseComponent", path: "components/service/service-base/api", - attributes: ["attr", "service", "service-type", "entity","query-fallback-function", "query-on-init", "query-on-bind", "pageable", "columns", "keys", "parent-keys", "static-data", "query-method", "paginated-query-method", "query-rows", "insert-method", "update-method", "delete-method", "store-state", "query-with-null-parent-keys"] + attributes: ["attr", "service", "service-type", "entity","query-fallback-function", "query-on-init", "query-on-bind", "pageable", "columns", "keys", "parent-keys", "static-data", "query-method", "paginated-query-method", "query-rows", "insert-method", "update-method", "delete-method", "store-state", "query-with-null-parent-keys", "configure-service-args"] },{ component: "OServiceComponent", path: "components/service/service/api", diff --git a/_data/components/ocomboData/00combo.yml b/_data/components/ocomboData/00combo.yml index e59e09853..3bb86ab7b 100644 --- a/_data/components/ocomboData/00combo.yml +++ b/_data/components/ocomboData/00combo.yml @@ -7,7 +7,7 @@ inheritedAttributes: [{ },{ component: "OFormServiceComponent", path: "components/input/overviewservice/api", - attributes: ["static-data", "entity", "service", "columns", "value-column", "value-column-type", "parent-keys", "description-columns", "separator", "query-on-init", "query-on-bind", "query-on-event", "query-method", "service-type", "query-with-null-parent-keys", "set-value-on-value-change", "translate", "sort"] + attributes: ["static-data", "entity", "service", "columns", "value-column", "value-column-type", "parent-keys", "description-columns", "separator", "query-on-init", "query-on-bind", "query-on-event", "query-method", "service-type", "query-with-null-parent-keys", "set-value-on-value-change", "translate", "sort", "configure-service-args"] }] inheritedOutputs: [{ diff --git a/_data/components/olistpickerData/00listPicker.yml b/_data/components/olistpickerData/00listPicker.yml index 82ce273cd..9cd1e8a93 100644 --- a/_data/components/olistpickerData/00listPicker.yml +++ b/_data/components/olistpickerData/00listPicker.yml @@ -7,7 +7,7 @@ inheritedAttributes: [{ },{ component: "OFormServiceComponent", path: "components/input/overviewservice/api", - attributes: ["static-data", "entity", "service", "columns", "value-column", "value-column-type", "parent-keys", "description-columns", "separator", "query-on-init", "query-on-bind", "query-on-event", "query-method", "service-type", "query-with-null-parent-keys", "set-value-on-value-change", "translate", "sort"] + attributes: ["static-data", "entity", "service", "columns", "value-column", "value-column-type", "parent-keys", "description-columns", "separator", "query-on-init", "query-on-bind", "query-on-event", "query-method", "service-type", "query-with-null-parent-keys", "set-value-on-value-change", "translate", "sort", "configure-service-args"] }] attributes: [{ diff --git a/_data/components/otableData/00table.yml b/_data/components/otableData/00table.yml index a31baf6f7..a302dbb03 100644 --- a/_data/components/otableData/00table.yml +++ b/_data/components/otableData/00table.yml @@ -5,7 +5,7 @@ directive: "o-table" inheritedAttributes: [{ component: "OServiceBaseComponent", path: "components/service/service-base/api", - attributes: ["attr", "service", "service-type", "entity", "query-fallback-function", "query-on-init", "query-on-bind", "pageable", "columns", "keys *", "parent-keys", "static-data", "query-method", "paginated-query-method", "query-rows", "insert-method", "update-method", "delete-method", "store-state", "query-with-null-parent-keys"] + attributes: ["attr", "service", "service-type", "entity", "query-fallback-function", "query-on-init", "query-on-bind", "pageable", "columns", "keys *", "parent-keys", "static-data", "query-method", "paginated-query-method", "query-rows", "insert-method", "update-method", "delete-method", "store-state", "query-with-null-parent-keys", "configure-service-args"] },{ component: "OServiceComponent", path: "components/service/service/api", diff --git a/_data/components/otableData/renderers/09tableColumnRendererService.yml b/_data/components/otableData/renderers/09tableColumnRendererService.yml index 08f2a0bdc..0769fa160 100644 --- a/_data/components/otableData/renderers/09tableColumnRendererService.yml +++ b/_data/components/otableData/renderers/09tableColumnRendererService.yml @@ -22,6 +22,8 @@ attributes: [{ name: "query-method" },{ name: "service-type" +},{ + name: "configure-service-args" }] inherit_properties: [{ diff --git a/_data/components/overviewService.yml b/_data/components/overviewService.yml index 1ba0bd127..75159bfef 100644 --- a/_data/components/overviewService.yml +++ b/_data/components/overviewService.yml @@ -79,6 +79,8 @@ attributes: [{ default: "", required: "", description: "Indicates the order ascending or descending of the option values" +},{ + name: "configure-service-args" }] outputs: [{ diff --git a/_data/components/overviewchart.yml b/_data/components/overviewchart.yml index 07e257e0e..5cf40ef63 100644 --- a/_data/components/overviewchart.yml +++ b/_data/components/overviewchart.yml @@ -5,7 +5,7 @@ apiTitle: "OChartComponent" inheritedAttributes: [{ component: "OServiceBaseComponent", path: "components/service/service-base/api", - attributes: ["attr", "service", "service-type", "entity", "query-fallback-function", "query-on-init", "query-on-bind", "pageable", "columns", "keys", "parent-keys", "static-data", "query-method", "query-rows", "store-state", "query-with-null-parent-keys"] + attributes: ["attr", "service", "service-type", "entity", "query-fallback-function", "query-on-init", "query-on-bind", "pageable", "columns", "keys", "parent-keys", "static-data", "query-method", "query-rows", "store-state", "query-with-null-parent-keys", "configure-service-args"] }] attributes: [{ diff --git a/_data/components/radio.yml b/_data/components/radio.yml index afe9f8c95..2dcad1e32 100644 --- a/_data/components/radio.yml +++ b/_data/components/radio.yml @@ -9,7 +9,7 @@ inheritedAttributes: [{ },{ component: "OFormServiceComponent", path: "components/input/overviewservice/api", - attributes: ["static-data", "entity", "service", "columns", "value-column", "value-column-type", "parent-keys", "visible-columns", "separator", "query-on-init", "query-on-bind", "query-on-event", "query-method", "service-type", "query-with-null-parent-keys", "set-value-on-value-change", "translate", "sort"] + attributes: ["static-data", "entity", "service", "columns", "value-column", "value-column-type", "parent-keys", "visible-columns", "separator", "query-on-init", "query-on-bind", "query-on-event", "query-method", "service-type", "query-with-null-parent-keys", "set-value-on-value-change", "translate", "sort", "configure-service-args"] }] inheritedOutputs: [{ diff --git a/_data/components/service.yml b/_data/components/service.yml index 272686f77..20f6f7a9d 100644 --- a/_data/components/service.yml +++ b/_data/components/service.yml @@ -5,7 +5,7 @@ propertiesColumns: ["Name", "Type", "Required", "Description"] inheritedAttributes: [{ component: "OServiceBaseComponent", path: "components/service/service-base/api", - attributes: ["attr", "static-data", "service", "service-type","query-fallback-function", "query-method", "entity", "keys", "parent-keys", "columns", "query-on-init", "query-on-bind", "query-rows", "insert-method", "update-method", "paginated-query-method", "delete-method", "pageable", "store-state", "query-with-null-parent-keys"] + attributes: ["attr", "static-data", "service", "service-type","query-fallback-function", "query-method", "entity", "keys", "parent-keys", "columns", "query-on-init", "query-on-bind", "query-rows", "insert-method", "update-method", "paginated-query-method", "delete-method", "pageable", "store-state", "query-with-null-parent-keys", "configure-service-args"] }] attributes: [{ diff --git a/_data/components/serviceBase.yml b/_data/components/serviceBase.yml index 990701f8b..4583fc1c1 100644 --- a/_data/components/serviceBase.yml +++ b/_data/components/serviceBase.yml @@ -55,6 +55,8 @@ attributes: [{ description: "Function to execute on query error", type: "Function", default: "No value" +},{ + name: "configure-service-args" } ] From 1ae9a39bcb045f3dcbcb34e69149bb5657959ede Mon Sep 17 00:00:00 2001 From: "IMATIASL\\patricia.martinez" Date: Mon, 21 Apr 2025 12:13:25 +0200 Subject: [PATCH 4/9] Updated breaking change about type SERVICE_CONFIG --- docs/guide/11-app-config.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guide/11-app-config.md b/docs/guide/11-app-config.md index f5a6d9d9d..378c010e9 100644 --- a/docs/guide/11-app-config.md +++ b/docs/guide/11-app-config.md @@ -326,7 +326,7 @@ Ontimize Web supports **OntimizeEE** and **JSON:API**, to configure this standa In this object, each key represents a different service used in the application. Each service must include a `path` property, where you define the service's path—excluding the base URL specified in the apiEndpoint attribute of the application configuration. ```javascript -export const SERVICE_CONFIG: Object = { +export const SERVICE_CONFIG = { 'users': { 'path': '/users' }, From 27be91015b09bddd6744555f7d79171bfcbfb67a Mon Sep 17 00:00:00 2001 From: "IMATIASL\\patricia.martinez" Date: Mon, 21 Apr 2025 12:13:48 +0200 Subject: [PATCH 5/9] Updated gemfile --- Gemfile.lock | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Gemfile.lock b/Gemfile.lock index 2b5f3c5f4..d8458f90c 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -63,8 +63,9 @@ GEM rexml (3.2.6) rouge (4.2.1) safe_yaml (1.0.5) - sass-embedded (1.63.6-x86_64-linux-gnu) + sass-embedded (1.63.6) google-protobuf (~> 3.23) + rake (>= 13.0.0) terminal-table (3.0.2) unicode-display_width (>= 1.1.1, < 3) unicode-display_width (2.5.0) From e9d3667a42be35f320a23a662a6431391a288928 Mon Sep 17 00:00:00 2001 From: "IMATIASL\\patricia.martinez" Date: Tue, 13 May 2025 16:24:33 +0200 Subject: [PATCH 6/9] Added new section jsonapi services --- _data/menu_descriptions.yml | 9 +- _includes/nav_cards.html | 2 - ...napi_service_request_example_response.json | 128 ++++++++++ assets/images/jsonapi-request.png | Bin 0 -> 16997 bytes assets/images/jsonapi-response.png | Bin 0 -> 53340 bytes assets/images/menus/services/jsonapi.svg | 1 + assets/images/menus/services/jsonapi_dark.svg | 9 + assets/images/menus/services/ontimize.svg | 6 + .../images/menus/services/ontimize_dark.svg | 6 + docs/guide/15-service.md | 233 ++++------------- docs/guide/services/15d-ontimize.md | 159 ++++++++++++ docs/guide/services/15e-jsonapi.md | 235 ++++++++++++++++++ 12 files changed, 607 insertions(+), 181 deletions(-) create mode 100644 assets/examples/jsonapi_service_request_example_response.json create mode 100644 assets/images/jsonapi-request.png create mode 100644 assets/images/jsonapi-response.png create mode 100644 assets/images/menus/services/jsonapi.svg create mode 100644 assets/images/menus/services/jsonapi_dark.svg create mode 100644 assets/images/menus/services/ontimize.svg create mode 100644 assets/images/menus/services/ontimize_dark.svg create mode 100644 docs/guide/services/15d-ontimize.md create mode 100644 docs/guide/services/15e-jsonapi.md diff --git a/_data/menu_descriptions.yml b/_data/menu_descriptions.yml index ea819a0fa..5c115118e 100644 --- a/_data/menu_descriptions.yml +++ b/_data/menu_descriptions.yml @@ -417,4 +417,11 @@ sections: imagepath: "/assets/images/menus/addons/keycloak" - url: "/addons/report/" title: "Report" - imagepath: "/assets/images/menus/addons/report" \ No newline at end of file + imagepath: "/assets/images/menus/addons/report" + "services": + - url: "/guide/service/jsonapi" + title: "JSON:API " + imagepath: "/assets/images/menus/services/jsonapi" + - url: "/guide/service/ontimize" + title: "Ontimize" + imagepath: "/assets/images/menus/services/ontimize" diff --git a/_includes/nav_cards.html b/_includes/nav_cards.html index fbbef5fa4..696626b64 100644 --- a/_includes/nav_cards.html +++ b/_includes/nav_cards.html @@ -20,8 +20,6 @@ - -