search

epam / edp-ddm-architecture

6 stars 2 forks source link

Не інформативні приклади #52

Closed scorpio-84 closed 1 year ago

scorpio-84 commented 1 year ago
  1. Відсутній опис таблиці (поля, звя'зки).
  2. Відсутній SQL аналог такого пошуку.
  3. Відсутній відповідний http-запит, де буде відповідний параметр пошуку
  4. Не зрозуміло, що маємо на виході. Які значення будуть виведені? Який буде ResultSet? При чому тут COUNT?

https://github.com/epam/edp-ddm-architecture/blob/56cf596eb8aae82880c263b63792a20c7303d93c/docs/ua/modules/registry-develop/pages/data-modeling/data/physical-model/liquibase-ddm-ext.adoc?plain=1#L437-L592

Приклад де все гарно розписано: https://epam.github.io/edp-ddm-architecture/ua/platform/1.9.6/registry-develop/data-modeling/data/physical-model/join-and-or-usage.html

antontuhai commented 1 year ago

Thank you for your detailed feedback on our documentation. We truly appreciate the time you took to review and provide us with areas of improvement. I want to address each point you raised:

  1. We have incorporated a comprehensive table description detailing each field.
  2. We have added the corresponding SQL representation for the search to clarify how such queries can be constructed.
  3. We have also integrated the relevant HTTP requests with the appropriate search parameter to provide a clearer understanding of how to execute such queries.
  4. We have elaborated on the expected outputs and clarified the roles of the system's SQL functions. We opted not to include result sets in the documentation for clarity and simplicity. Developers will have the necessary tools and expertise to review data directly. Our aim remains to keep the documentation functional and not overwhelming.

See updates in 84b321ee3028494a5fdb5fa9be6593b1235f9954.