diff --git a/persistence-service-v1/persistence-service-external-api-v2/src/main/resources/api/documine.yaml b/persistence-service-v1/persistence-service-external-api-v2/src/main/resources/api/documine.yaml index 769a0363c..62e0f1818 100644 --- a/persistence-service-v1/persistence-service-external-api-v2/src/main/resources/api/documine.yaml +++ b/persistence-service-v1/persistence-service-external-api-v2/src/main/resources/api/documine.yaml @@ -404,24 +404,33 @@ paths: post: operationId: uploadMapping summary: Upload a new component mapping to a DossierTemplate. - description: | + description: | Use this endpoint to upload a new component mapping to a specific DossierTemplate. - - **File Format:** CSV (comma-separated values). - - **Header:** The first row should contain column labels. - - **Data Structure:** Ensure all rows have the same number of columns (rectangular data). - - **Sorting:** Rows will be sorted by the values in each column, from left to right, for faster lookups. - - **Customization:** Users can specify the delimiter and encoding of the CSV file. - - **Usage** The component mapping file can be used in component rules to relate components to existing master data. + #### File Requirements + - **Format:** The file must be in CSV (comma-separated values) format. + - **Header Row:** The first row should contain the column labels. + - **Data Consistency:** All rows must have the same number of columns to ensure rectangular data structure. - **Tip:** Place keys to be queried in the first columns and results to be mapped in the last column for best performance. + #### Sorting and Performance + - **Sorting:** Rows are automatically sorted by the values in each column, from left to right, to enhance lookup speed. + - **Optimization Tip:** Place keys to be queried in the first columns and the results to be mapped in the last column for best performance. + + #### Customization Options + Users can specify the delimiter and encoding used in the CSV file. + + #### Usage + The component mapping file can be utilized in component rules to relate components to existing master data. + + #### Example + + | search_value | mapped_value | + |--------------|--------------| + | Alice | Manager | + | Bob | Developer | + | Charlie | Analyst | + - Example: - | search_value | mapped_value | - | ------------ | ------------ | - | Alice | Manager | - | Bob | Developer | - | Charlie | Analyst | tags: - 1. Dossier Templates requestBody: @@ -500,21 +509,20 @@ paths: description: | Use this endpoint to update an existing component mapping of a specific dossier template. - - **File Format:** CSV (comma-separated values). - - **Header:** The first row should contain column labels. - - **Data Structure:** Ensure all rows have the same number of columns (rectangular data). - - **Sorting:** Rows will be sorted by the values in each column, from left to right, for faster lookups. - - **Customization:** Users can specify the delimiter and encoding of the CSV file. - - **Usage** The component mapping file can be used in component rules to relate components to existing master data. + #### File Requirements + - **Format:** The file must be in CSV (comma-separated values) format. + - **Header Row:** The first row should contain the column labels. + - **Data Consistency:** All rows must have the same number of columns to ensure rectangular data structure. - **Tip:** Place keys to be queried in the first columns and results to be mapped in the last column for best performance. + #### Sorting and Performance + - **Sorting:** Rows are automatically sorted by the values in each column, from left to right, to enhance lookup speed. + - **Optimization Tip:** Place keys to be queried in the first columns and the results to be mapped in the last column for best performance. + + #### Customization Options + Users can specify the delimiter and encoding used in the CSV file. - Example: - | search_value | mapped_value | - | ------------ | ------------ | - | Alice | Manager | - | Bob | Developer | - | Charlie | Analyst | + #### Usage + The component mapping file can be utilized in component rules to relate components to existing master data. tags: - 1. Dossier Templates requestBody: