dedica-team · bonndan · Jan 25, 2022 · Feb 5, 2022 · Feb 22, 2022 · Feb 22, 2022
diff --git a/docs/source/inc_searchFields.rst b/docs/source/inc_searchFields.rst
@@ -0,0 +1,17 @@
+* ``identifier`` The local identifier of the component without parent identifier
+* ``address`` address/url of an item
+* ``capability`` capability
+* ``component`` class of the component (item, group, relation...)
+* ``context`` parent context
+* ``description`` description of the component
+* ``framework`` frameworks of an item
+* ``group`` parent group
+* ``layer`` domain layer or technical layer
+* ``lifecycle`` network(s) of the component
+* ``name`` name of the component
+* ``network`` network(s) of the component
+* ``owner`` owner of the component
+* ``tag`` assigned tag(s)
+* ``type`` type of the component
+* ``unit`` parent unit
+* ``parent`` identifier of the parent component
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -31,6 +31,7 @@ sources, like files and web APIs (e.g. monitoring items) or allows pushing infor
    input
    model
    assessment
+   searching
    magic
    output
    troubleshooting

diff --git a/docs/source/magic.rst b/docs/source/magic.rst
@@ -8,7 +8,7 @@ Often lots of items can be read from input data sources, but no information on l
 that, you can describe groups and use the ``contains`` field:
 
 * To pick items by their identifier, add single strings which are treated as identifiers.
-* Furthermore you can use SQL-like WHERE conditions to assign items to groups. In the following example ``identifier LIKE 'DB1%'`` is the query which would match both items.
+* Furthermore you can use Lucene search terms conditions to assign items to groups. In the following example ``identifier:DB1*`` is the query which would match both items. See :ref:`Searching`
 
 .. code-block:: yaml
    :linenos:
@@ -29,7 +29,7 @@ that, you can describe groups and use the ``contains`` field:
         team: Admins
         contains:
           - DB1
-          - "identifier LIKE 'DB1%'"
+          - "identifier:DB1*"
 
 
 Using Templates to dynamically assign data
@@ -43,6 +43,8 @@ if the target value is null.
 Multiple templates can be assigned to items too. In this case the first assigned value "wins" and
 will not be overwritten by templates applied later.
 
+Template matching also supports Lucene search terms (see :ref:`Searching`).
+
 .. code-block:: yaml
    :linenos:
 
@@ -64,8 +66,6 @@ will not be overwritten by templates applied later.
       endOfLife:
         tags: [eol]
 
-For CQ queries read https://github.com/npgall/cqengine#string-based-queries-sql-and-cqn-dialects.
-
 
 Using Labels to assign data
 ---------------------------
@@ -90,6 +90,7 @@ Labels can be set using docker-compose files too. However, docker labels do not
 
 Remember to escape URLs with double quotes.
 
+
 Relations between landscape items
 ---------------------------------
 

diff --git a/docs/source/model.rst b/docs/source/model.rst
@@ -18,6 +18,7 @@ infrastructure. Both landscapes could have items in common (like a database, loa
 .. include:: ./schema/Models/Branding.rst
 .. include:: ./schema/Models/GroupDescription.rst
 .. include:: ./schema/Models/ItemDescription.rst
+.. include:: ./schema/Models/ProcessDescription.rst
 .. include:: ./schema/Models/InterfaceDescription.rst
 .. include:: ./schema/Models/Link.rst
 
@@ -88,6 +89,40 @@ Groups can have the following attributes:
       infrastructure:
         team: Admins
 
+Processes
+---------
+Groups can have the following attributes:
+
+* ``identifier``: A unique identifier in the landscape. Provided automatically via the dictionary key, so do not set it.
+* ``contains`` Array of references to other items (identifiers and CQN queries).
+* ``owner`` Owning party (e.g. marketing).
+* ``description`` A short description.
+* ``team`` Technical owner.
+* ``contact`` Support/notification contact (email). May be addressed in case of errors.
+* ``color`` A hex color code for rendering.
+* ``links`` A map/dictionary of URLs to more information.
+
+**Process configuration**
+
+.. code-block:: yaml
+   :linenos:
+
+    processes:
+      ingestion:
+        description: Data gathering
+        owner: Joe Armstrong
+        team: Team Content
+        contact: [email protected]
+        color: "#345345"
+        links:
+          wiki: http://wiki.acme.org/ingestion_process
+        branches:
+          - items:
+            - foo/baz
+            - foo/bar
+            - anothergroup/anotheritem
+
+
 
 Item Identification and Referencing
 ------------------------------------

diff --git a/docs/source/output.rst b/docs/source/output.rst
@@ -1,14 +1,6 @@
 Output
 ======
 
-
-Searching
----------
-
-Nivio indexes all landscape items in an in-memory search engine called Lucene. You can build sophisticated queries on
-various item fields (see :ref:`Model and Syntax`). For further information see https://www.lucenetutorial.com/lucene-query-syntax.html
-
-
 Modifying Item Appearance
 -------------------------
 

diff --git a/docs/source/schema/.openapi-generator/FILES b/docs/source/schema/.openapi-generator/FILES
@@ -1,10 +1,10 @@
 Models/Branding.rst
-Models/GroupDescription.rst
 Models/InterfaceDescription.rst
 Models/ItemDescription.rst
 Models/KPIConfig.rst
 Models/LandscapeConfig.rst
 Models/LandscapeDescription.rst
 Models/LayoutConfig.rst
 Models/Link.rst
+Models/PartDescription.rst
 README.rst
diff --git a/docs/source/schema/Models/ContextDescription.rst b/docs/source/schema/Models/ContextDescription.rst
@@ -0,0 +1,86 @@
+ContextDescription
+---------------
+
+Description of contexts (optional, can also be given in sources).
+
+
+.. list-table::
+   :header-rows: 1
+
+   * - Name
+     - Type
+     - Description
+     - Remarks
+     - Example
+
+   * - color
+     - String
+     - The HTML (hexcode only!) color used to draw the group and its items. If no color is given, one is computed.
+     - optional, defaults to null
+     - 05ffaa
+   * - contact
+     - String
+     - A contact method, preferably email.
+     - optional, defaults to null
+     - null
+   * - contains
+     - List
+     - A list of item identifiers or SQL-like queries to easily assign items to this group.
+     - optional, defaults to null
+     - identifier LIKE 'DB1'
+   * - description
+     - String
+     - A brief description.
+     - optional, defaults to null
+     - null
+   * - fullyQualifiedIdentifier
+     - URI<URI>
+     - 
+     - optional, defaults to null
+     - null
+   * - identifier
+     - String
+     - A unique identifier for the group (also used as name). Descriptions are merged based on the identifier.
+     - **required**, defaults to null
+     - shipping
+   * - labels
+     - Map
+     - 
+     - optional, defaults to null
+     - null
+   * - links
+     - Map<Link>
+     - Key-value pairs of related links. Some keys like &#39;github&#39; cause that the endpoint data is parsed and added to to corresponding landscape component.
+     - optional, defaults to null
+     - github: https://github.com/dedica-team/nivio
+   * - name
+     - String
+     - A human-readable name
+     - **required**, defaults to null
+     - null
+   * - owner
+     - String
+     - The business owner of the group.
+     - optional, defaults to null
+     - null
+   * - parentIdentifier
+     - String
+     - 
+     - optional, defaults to null
+     - null
+   * - tags
+     - List
+     - 
+     - optional, defaults to null
+     - null
+   * - type
+     - String
+     - The type of the component. A string describing its nature. If no icon is set, the type determines the displayed icon.
+     - optional, defaults to null
+     - null
+   * - unit
+     - String
+     - The parent identifier
+     - optional, defaults to null
+     - shipping
+
diff --git a/docs/source/schema/Models/GroupDescription.rst b/docs/source/schema/Models/GroupDescription.rst
@@ -28,13 +28,18 @@ A group of items. Could be used as bounded context, for instance.
      - A list of item identifiers or SQL-like queries to easily assign items to this group.
      - optional, defaults to null
      - identifier LIKE 'DB1'
+   * - context
+     - String
+     - 
+     - optional, defaults to null
+     - null
    * - description
      - String
      - A brief description.
      - optional, defaults to null
      - null
-   * - environment
-     - String
+   * - fullyQualifiedIdentifier
+     - URI<URI>
      - 
      - optional, defaults to null
      - null
@@ -55,12 +60,27 @@ A group of items. Could be used as bounded context, for instance.
      - github: https://github.com/dedica-team/nivio
    * - name
      - String
-     - 
-     - optional, defaults to null
+     - A human-readable name
+     - **required**, defaults to null
      - null
    * - owner
      - String
      - The business owner of the group.
      - optional, defaults to null
      - null
+   * - parentIdentifier
+     - String
+     - 
+     - optional, defaults to null
+     - null
+   * - tags
+     - List
+     - 
+     - optional, defaults to null
+     - null
+   * - type
+     - String
+     - The type of the component. A string describing its nature. If no icon is set, the type determines the displayed icon.
+     - optional, defaults to null
+     - null
 
diff --git a/docs/source/schema/Models/ItemDescription.rst b/docs/source/schema/Models/ItemDescription.rst
@@ -1,7 +1,7 @@
 ItemDescription
 ---------------
 
-List of configuration sources. Handled in the given order, latter extend/overwrite earlier values like items etc.
+
 
 
 .. list-table::
@@ -13,21 +13,31 @@ List of configuration sources. Handled in the given order, latter extend/overwri
      - Remarks
      - Example
 
+   * - \_links
+     - Map<Link>
+     - Key-value pairs of related links. Some keys like &#39;github&#39; cause that the endpoint data is parsed and added to to corresponding landscape component.
+     - optional, defaults to null
+     - github: https://github.com/dedica-team/nivio
    * - address
      - String
      - The technical address of the item (should be an URI). Taken into account when matching relation endpoints.
      - optional, defaults to null
      - null
    * - color
      - String
-     - Overrides the group color. Use an HTML hex color code without the leading hash.
+     - The HTML (hexcode only!) color used to draw the group and its items. If no color is given, one is computed.
      - optional, defaults to null
-     - 4400FF
+     - 05ffaa
    * - contact
      - String
-     - The primary way to contact a responsible person or team. Preferably use an email address.
+     - A contact method, preferably email.
+     - optional, defaults to null
+     - null
+   * - contains
+     - List
+     - A list of item identifiers or SQL-like queries to easily assign items to this group.
      - optional, defaults to null
-     - [email protected]
+     - identifier LIKE 'DB1'
    * - description
      - String
      - A brief description.
@@ -38,21 +48,21 @@ List of configuration sources. Handled in the given order, latter extend/overwri
      - The parts used to create the item. Usually refers to technical frameworks.
      - optional, defaults to null
      - java: 8
+   * - fullyQualifiedIdentifier
+     - URI<URI>
+     - 
+     - **required**, defaults to null
+     - null
    * - group
      - String
      - The identifier of the group this item belongs in. Every item requires to be member of a group internally, so if nothing is given, the value is set to its layer.
      - optional, defaults to null
      - shipping
-   * - icon
-     - String
-     - An icon name or URL to set the displayed map icon. The default icon set is https://materialdesignicons.com/ and all names can be used (aliases do not work).
-     - optional, defaults to null
-     - null
    * - identifier
      - String
-     - Immutable unique identifier (maybe use an URN). Primary means to identify items in searches.
+     - A unique identifier for the group (also used as name). Descriptions are merged based on the identifier.
      - **required**, defaults to null
-     - null
+     - shipping
    * - interfaces
      - Set<InterfaceDescription>
      - A collection of low level interfaces. Can be used to describe HTTP API endpoints for instance.
@@ -80,14 +90,24 @@ List of configuration sources. Handled in the given order, latter extend/overwri
      - github: https://github.com/dedica-team/nivio
    * - name
      - String
-     - A human readable name/title. The name is considered when items are searched.
-     - optional, defaults to null
-     - my beautiful service
+     - A human-readable name
+     - **required**, defaults to null
+     - null
    * - owner
      - String
-     - The business owner of the item. Preferably use an email address.
+     - The business owner of the group.
      - optional, defaults to null
-     - [email protected]
+     - null
+   * - parentIdentifier
+     - String
+     - 
+     - optional, defaults to null
+     - null
+   * - parts
+     - Set<PartDescription>
+     - Subcomponents
+     - optional, defaults to null
+     - null
    * - providedBy
      - List
      - A collection of identifiers which are providers for this item (i.e. hard dependencies that are required). This is a convenience field to build relations.
@@ -110,7 +130,7 @@ List of configuration sources. Handled in the given order, latter extend/overwri
      - null
    * - type
      - String
-     - The type of the item. A string describing its nature. If no icon is set, the type determines the displayed icon.
+     - The type of the component. A string describing its nature. If no icon is set, the type determines the displayed icon.
      - optional, defaults to null
-     - service|database|volume
+     - null