Documentation about adaptation JSON:API

.github/workflows/ci.yml

@@ -15,7 +15,7 @@ jobs:
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.1' # Not needed with a .ruby-version file
+          ruby-version: '3.2' # Not needed with a .ruby-version file
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
           cache-version: 0 # Increment this number if you need to re-download cached gems
       - name: Build with Jekyll

Gemfile.lock

@@ -1,21 +1,58 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.6)
-      public_suffix (>= 2.0.2, < 6.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    bigdecimal (3.2.2)
     colorator (1.1.0)
-    concurrent-ruby (1.2.3)
+    concurrent-ruby (1.3.5)
     em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0)
     eventmachine (1.2.7)
-    ffi (1.16.3)
+    ffi (1.17.2)
+    ffi (1.17.2-aarch64-linux-gnu)
+    ffi (1.17.2-aarch64-linux-musl)
+    ffi (1.17.2-arm-linux-gnu)
+    ffi (1.17.2-arm-linux-musl)
+    ffi (1.17.2-arm64-darwin)
+    ffi (1.17.2-x86-linux-gnu)
+    ffi (1.17.2-x86-linux-musl)
+    ffi (1.17.2-x86_64-darwin)
+    ffi (1.17.2-x86_64-linux-gnu)
+    ffi (1.17.2-x86_64-linux-musl)
     forwardable-extended (2.6.0)
-    google-protobuf (3.25.3-x86_64-linux)
+    google-protobuf (4.31.1)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.31.1-aarch64-linux-gnu)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.31.1-aarch64-linux-musl)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.31.1-arm64-darwin)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.31.1-x86-linux-gnu)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.31.1-x86-linux-musl)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.31.1-x86_64-darwin)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.31.1-x86_64-linux-gnu)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.31.1-x86_64-linux-musl)
+      bigdecimal
+      rake (>= 13)
     http_parser.rb (0.8.0)
-    i18n (1.14.4)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    jekyll (4.3.3)
+    jekyll (4.3.4)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
@@ -33,8 +70,8 @@ GEM
       webrick (~> 1.7)
     jekyll-include-cache (0.2.1)
       jekyll (>= 3.7, < 5.0)
-    jekyll-sass-converter (3.0.0)
-      sass-embedded (~> 1.54)
+    jekyll-sass-converter (3.1.0)
+      sass-embedded (~> 1.75)
     jekyll-seo-tag (2.8.0)
       jekyll (>= 3.8, < 5.0)
     jekyll-watch (2.2.1)
@@ -44,8 +81,8 @@ GEM
       jekyll-include-cache
       jekyll-seo-tag (>= 2.0)
       rake (>= 12.3.1)
-    kramdown (2.4.0)
-      rexml
+    kramdown (2.5.1)
+      rexml (>= 3.3.9)
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     liquid (4.0.4)
@@ -55,27 +92,74 @@ GEM
     mercenary (0.4.0)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    public_suffix (5.0.5)
-    rake (13.2.1)
+    public_suffix (6.0.2)
+    rake (13.3.0)
     rb-fsevent (0.11.2)
-    rb-inotify (0.10.1)
+    rb-inotify (0.11.1)
       ffi (~> 1.0)
-    rexml (3.2.6)
-    rouge (4.2.1)
+    rexml (3.4.1)
+    rouge (4.5.2)
     safe_yaml (1.0.5)
-    sass-embedded (1.63.6-x86_64-linux-gnu)
-      google-protobuf (~> 3.23)
+    sass-embedded (1.89.2)
+      google-protobuf (~> 4.31)
+      rake (>= 13)
+    sass-embedded (1.89.2-aarch64-linux-android)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.89.2-aarch64-linux-gnu)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.89.2-aarch64-linux-musl)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.89.2-arm-linux-androideabi)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.89.2-arm-linux-gnueabihf)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.89.2-arm-linux-musleabihf)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.89.2-arm64-darwin)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.89.2-riscv64-linux-android)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.89.2-riscv64-linux-gnu)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.89.2-riscv64-linux-musl)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.89.2-x86_64-darwin)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.89.2-x86_64-linux-android)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.89.2-x86_64-linux-gnu)
+      google-protobuf (~> 4.31)
+    sass-embedded (1.89.2-x86_64-linux-musl)
+      google-protobuf (~> 4.31)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
-    unicode-display_width (2.5.0)
-    webrick (1.8.1)
+    unicode-display_width (2.6.0)
+    webrick (1.9.1)
 
 PLATFORMS
-  x86_64-linux
+  aarch64-linux-android
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-androideabi
+  arm-linux-gnu
+  arm-linux-gnueabihf
+  arm-linux-musl
+  arm-linux-musleabihf
+  arm64-darwin
+  riscv64-linux-android
+  riscv64-linux-gnu
+  riscv64-linux-musl
+  ruby
+  x86-linux-gnu
+  x86-linux-musl
+  x86_64-darwin
+  x86_64-linux-android
+  x86_64-linux-gnu
+  x86_64-linux-musl
 
 DEPENDENCIES
   jekyll (~> 4.3.3)
   just-the-docs (= 0.8.2)
 
 BUNDLED WITH
-   2.4.20
+   2.6.9

_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"
+   }
+
 }

_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: [{

_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",

_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",

_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: [{

_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: [{

_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",

_data/components/otableData/renderers/09tableColumnRendererService.yml

@@ -22,6 +22,8 @@ attributes: [{
   name: "query-method"
 },{
   name: "service-type"
+},{
+  name: "configure-service-args"
 }]
 
 inherit_properties: [{

_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: [{

_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: [{

_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: [{

_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: [{

_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"
 }
 ]
 

_data/menu_descriptions.yml

@@ -347,7 +347,7 @@ sections:
       description: "Section that resolves common questions about Ontimize Web"
     - url: "/versions/"
       title: "Releases"
-      description: "Tables of all the Onitimze Web releases and its compatibilities"
+      description: "Tables of all the Ontimize Web releases and its compatibilities"
     - url: "/migrations/"
       title: "Migration guides"
       description: "Download page of our version migration guides"
@@ -418,3 +418,11 @@ sections:
     - url: "/addons/report/"
       title: "Report"
       imagepath: "/assets/images/menus/addons/report"
+  "services":
+    - url: "/guide/service/jsonapi"
+      title: "JSON:API <label class='label label-green'>New</label>"
+      imagepath: "/assets/images/menus/services/jsonapi"
+    - url: "/guide/service/ontimize"
+      title: "Ontimize"
+      imagepath: "/assets/images/menus/services/ontimize"
+

_includes/nav_cards.html

@@ -20,8 +20,6 @@
                   </div>
                 </a>
 
-
-
                 <a class="card-light" href="{{ base_path }}{{ section.url }}">
                   <div class="menu-card">
                     <div class="image-container">