Merge pull request #1495 from mia-platform/main

release v13.0.3 to preview

Author: albertotessarotto

Dockerfile

@@ -1,4 +1,4 @@
-FROM nginx:1.26.0-alpine
+FROM nginx:1.27.0-alpine
 
 LABEL maintainer="Mia Platform Core Team<[email protected]>" \
   name="Documentation" \

docs/console/project-configuration/manage-environment-variables/manage-environment-variables-with-gitlab.md

@@ -26,6 +26,20 @@ It is possible to find it in the table of the Envs area.
 
 ![envs-table](../img/environments_table.png)
 
+:::info
+You can also define a global variable to be used as a default and define a specific variable for only one environment.  
+In this case only the specified environment will use its value, and the others will use the default value.
+
+When there are both a global variable and a specific one for an environment, the longest matching variable will be selected.
+
+E.g.  
+You have three environments: `TEST`, `PREPROD` and `PROD`.  
+You define these two variables: `MY_VAR = foo` and `PROD_MY_VAR = bar`  
+This is what the environments will receive:  
+- TEST: `foo`
+- PREPROD: `foo`
+- PROD: `bar`
+:::
 
 :::warning
 Remember! It is fundamental to define a prefix if you want to associate a variable to a particular environment, otherwise the variable will be considered global.

docs/console/tutorials/configure-marketplace-components/api-portal.mdx

@@ -6,7 +6,7 @@ sidebar_label: API portal documentation
 
 import VideoBox from "./../../../src/components/VideoBox";
 
-In this tutorial, we will learn how to configure and use the [_API Portal_](/runtime_suite/api-portal/10_overview.md) and the [_Swagger Aggregator_](/runtime_suite/swagger-aggregator/10_overview.md) in order to provide the developers with a user-friendly interface that enables them to easily visualize and test endpoints of different microservices in a single place. It is built on top of the [OpenAPI 2.0](https://swagger.io/specification/v2/)/[OpenAPI 3.0](https://swagger.io/specification/) Specification.
+In this tutorial, we will learn how to configure and use the [_API Portal_](/runtime_suite/api-portal/10_overview.md) and the [_Swagger Aggregator_](/runtime_suite/swagger-aggregator/10_overview.md) in order to provide the developers with a user-friendly interface that enables them to easily visualize and test endpoints of different microservices in a single place. It is built on top of the [OpenAPI 2.0](https://swagger.io/specification/v2/)/[OpenAPI 3.0](https://swagger.io/specification/v3/)/[OpenAPI 3.1](https://swagger.io/specification/) Specification.
 
 ## What we will build
 
@@ -57,10 +57,16 @@ This application include the following components:
 - you can choose to create a new _API Gateway_ service or choose an already installed service. 
 
 and the following endpoints:
-- _/documentations/api-portal_ to the [_API Portal_](/runtime_suite/api-portal/10_overview.md) service 
-- _/documentations/api-portal/api_ to the [_Swagger Aggregator_](/runtime_suite/swagger-aggregator/10_overview.md) service
-- _/documentations/openapi_ to the [_Swagger Aggregator_](/runtime_suite/swagger-aggregator/10_overview.md) service
-- _/documentations/swagger_ to the [_Swagger Aggregator_](/runtime_suite/swagger-aggregator/10_overview.md) service
+- _/documentations/api-portal_ to the [_API Portal_](/runtime_suite/api-portal/10_overview.md) service
+- _/api/openapi_ to the [_Swagger Aggregator_](/runtime_suite/swagger-aggregator/10_overview.md) service which reroutes to `/openapi/v3-1`
+- _/api/openapi/raw_ to the [_Swagger Aggregator_](/runtime_suite/swagger-aggregator/10_overview.md) service
+
+:::note
+The _/api/openapi_ endpoint reroute depends on which Open API Specification you want to see:
+- `/openapi/v3-1` shows a [Open API v3.1](https://swagger.io/specification/)
+- `/openapi/v3` shows a [Open API v3](https://swagger.io/specification/v3/)
+- `/openapi/v2` shows a [Open API v2 (swagger)](https://swagger.io/specification/v2/)
+:::
 
 :::caution
 In the Mia-Platform Marketplace are available two different applications to install the _API Portal_ and _Swagger Aggregator_.

docs/development_suite/deploy/img/compare_and_review.png

@@ -166,12 +166,28 @@ It is not recommended to activate the checkbox in a production runtime environme
 This feature is only available to Projects that use [**Enhanced Project Workflow**](/development_suite/set-up-infrastructure/enhanced-project-workflow.md).
 :::
 
-When using the **Enhanced Project Workflow**, Kubernetes files are generated on deployment. After selecting the desired revision (or version), you can review generated Kubernetes files from the Console or even export these in `tar.gz` format to review them later.
+When using the **Enhanced Project Workflow**, Kubernetes files are generated on deployment. After selecting the desired revision (or version), you can:
 
-![ExportAndReview](./img/export-and-review-files.png)
+- compare the generated Kubernetes files with the previous version
+- review generated Kubernetes files from the Console or download them as a `.tar.gz` archive.
+
+Such functionalities are available through the respective buttons in the  `Configuration Files `card.
+
+![Compare and Review](./img/compare_and_review.png)
+
+#### Compare Changes
+
+By clicking on the `Compare changes` button, a diff-editor will show the differences between the configurations of the selected version and the previous one in a side-by-side view.
+
+On the bottom, a button allows you to download the configurations files as a `.tar.gz` archive.
+
+![Compare](./img/compare_changes.png)
+
+#### Review Configurations
 
 While reviewing the files, you can select the one you view to open from the menu on the left. You can see the file content full-screen by clicking the top-right button with four outgoing arrows.
 
+On the bottom, a button allows you to download the configurations files as a `.tar.gz` archive.
 ![Review](./img/review-configuration-files.png)
 
 ## History

docs/development_suite/deploy/img/compare_changes.png

@@ -316,9 +316,9 @@ Fixed link URL generation with special characters
 
 ### New Marketplace Components
 
-#### Mia-Assistant
+#### AI RAG Template
 
-The template of `Mia-Assistant`, our brand new AI Chatbot, is now officially available OSS in **Experimental** phase! 
+The `AI RAG` template, used by our brand new AI Chatbot Mia-Assistant, is now officially available OSS in **Beta** phase! 
 You can find the repository available [here](https://github.com/mia-platform/ai-rag-template). 
 
 ### Marketplace Updates

docs/development_suite/deploy/img/export-and-review-files.png

@@ -0,0 +1,93 @@
+---
+id: v13.0.3
+title: Version 13.0.3 Release Notes
+sidebar_label: v13.0.3
+image: "img/release-note-link-preview.png"
+---
+
+_June 21st, 2024_
+
+:::info
+Mia-Platform Console v13.0.3 is **now in Preview** and will be generally available on July 04th.
+
+Console SaaS users can try out v13.0.3 latest improvements in Preview! Open a Service Request to ask for the creation of a sandbox Company in case you do not have access to any Company.
+
+For self-hosted installations, please read the [following guidelines](#how-to-update-your-console).
+:::
+
+## Console
+
+### Compare changes at Deploy on Projects with the enhanced workflow
+
+In all the Projects using the enhanced workflow, it is now possible to compare all changes made in the configuration to be deployed with respect to the previous deployed configuration. Users will then be able to view all configuration files and their respective changes and easily search among them.
+
+![Compare Changes](img/compare_changes.png)
+
+### Restore previous configuration saves on Projects with the enhanced workflow
+
+On Projects with enhanced workflow you can now restore a previous configuration save from the revision history modal.  
+All you have to do is to open the revision action popover, click on the `History` button and select the menu item "Restore these changes" on the configuration save you want to restore. 
+
+![Restore Changes](img/restore-changes.png)
+
+### Vote the answers provided by Mia-Assistant
+
+From now on, you can send positive or negative feedback to the answers generated by Mia-Assistant by simply clicking the thumbs up or down at the end of each answer.  
+This feedback will then be gathered and analyzed to improve the overall performance of the chatbot.
+
+### Configure Metrics gathering for all the containers of a Microservice
+
+Once you have configured the Runtime Monitoring system for your Project, you can now define the scraping rules for each of your Microservice containers. You can perform such action in the `Monitoring` tab of each Microservice's details page.  
+For more information, visit the related [documentation page](/development_suite/api-console/api-design/microservice-monitoring.md).
+
+### Bug Fix
+
+This version addressed the following bugs:
+
+* fixed a bug that prevented the correct view of an iFrame extension when switching among two different iFrame extensions;
+* fixed a bug that caused a malfunction in the display of the Deploy area when rapidly switching among two different Projects.
+
+## Microfrontend Composer
+
+### Back-Kit Library
+
+The new version `v1.5.4` of the back-kit library is available!
+
+Refer to back-kit [changelog](/microfrontend-composer/back-kit/changelog.md) for finer-grained details of new versions.
+
+#### Improvements
+
+##### Exposed `customEvents` property of form modal and form drawer components
+
+It is now possible to add a new prop to the components `bk-dynamic-form-modal` and `bk-dynamic-form-drawer` called `customEvents` which takes the name of the event that the component will listen to and the mode which can be 'insert' or 'selected'.
+
+## Marketplace
+
+### Marketplace Updates
+
+#### API Portal
+
+We are excited to announce the release of API Portal version `2.0.0`! 
+
+
+This new version features an upgraded interface based on Swagger UI, providing enhanced support for all functionalities of the OpenAPI 3.1 specification.  Please note that there are a few breaking changes in this release. We strongly recommend reviewing the [updated documentation](/runtime_suite/api-portal/20_configuration.md#how-to-migrate-to-v2) to understand these changes.
+
+:::caution
+Anyone wishing to use API Portal version `2.0.0` to visualize CRUD Service documentation should update the latter to the latest patch of major 6 (`6.10.2` at the time of writing) or to the latest patch of major 7 (`7.0.3` at the time of writing), given the new, improved way of handling OpenAPI specification errors in the API Portal.
+:::
+
+#### CRUD Service
+
+The new version `7.0.3` of the CRUD Service is available!
+
+##### Bug Fix
+
+* Fixed projection example in json schema generator
+* `serializerCompiler` has been added to use explicitly fastifiy-fast-json, along with `AdditionalCaster`
+* `$eq` operator can now be used also for array fields
+* `/-/schemas` accept header defaults to `application/json`
+* `/schemas` and `/-/schemas` endpoints now return also `required` property
+
+## How to update your Console
+
+For self-hosted installations, please head to the [self hosted upgrade guide](/infrastructure/self-hosted/installation-chart/100_how-to-upgrade.md) or contact your Mia-Platform referent and upgrade to _Console Helm Chart_ `v13.4.0-beta.0`.

docs/development_suite/deploy/overview.md

@@ -7,6 +7,7 @@ slug: "/release-notes/versions"
 ---
 | Release | Release notes                              |
 |---------|--------------------------------------------|
+| v13.0.3 | [Read the release notes](/release-notes/v13.0.3.md) |
 | v13.0.2 | [Read the release notes](/release-notes/v13.0.2.md) |
 | v13.0.1 | [Read the release notes](/release-notes/v13.0.1.md) |
 | v13.0.0 | [Read the release notes](/release-notes/v13.0.0.md) |

docs/release-notes/img/compare_changes.png

@@ -10,9 +10,11 @@ DO NOT MODIFY IT BY HAND.
 Instead, modify the source file and run the aggregator to regenerate this file.
 -->
 
-The API Portal service will present you a graphical interface for your [Open Api specification document](https://swagger.io/resources/open-api/). This service is responsible for contacting an endpoint where your swagger Open Api document should be provided.
+![api-portal](./img/api-portal.png)
 
-This interface will semantically describe the APIs in a readable structure text format and will also allow you to interact and test each of them by clicking on the "Try it" button.
+The **API Portal** microservice will present you a graphical interface for your [Open Api specification document](https://swagger.io/resources/open-api/). This service is responsible for contacting an endpoint where your swagger Open Api document should be provided.
+
+This interface will semantically describe the APIs in a readable structure text format and will also allow you to interact and test each of them by clicking on the "Try it out" button.
 
 :::note
 The available Open Api document is automatically generated and kept in sync by [Swagger Aggregator](../swagger-aggregator/overview).  
@@ -24,3 +26,9 @@ The Open Api documentation lets you know exactly how your APIs will work and beh
 :::note
 API Portal generates the [Documentation Portal](../../console/project-configuration/documentation-portal) section of the Console where all services and CRUDs routes are shown and can be tested.
 :::
+
+## Features
+
+Other than showing your [Open Api specification document](https://swagger.io/resources/open-api/), the **API Portal** allows to filter it. It can be filtered by tags, methods and endpoint name.
+
+It's also possible to change the category which is a map of the [subswaggers](../../development_suite/api-console/advanced-section/swagger-aggregator/configuration#subswaggers) related to the [Swagger Aggregator](../swagger-aggregator/overview) microservice.