-
Notifications
You must be signed in to change notification settings - Fork 132
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
GITBOOK-22: Search Blocks Docs added
- Loading branch information
1 parent
022b7e7
commit 372f2d8
Showing
52 changed files
with
117 additions
and
24 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 changes: 3 additions & 0 deletions
3
docs/guardian/standard-registry/policies/search-block/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# 📂 Search Block | ||
|
||
Guardian policy authors can search for occurrences of the block usage in a similar context, i.e. embedded into the policy content of similar structure (surrounded by similar blocks), across all published policies within the Guardian instance using the search button in the policy editor. |
2 changes: 2 additions & 0 deletions
2
docs/guardian/standard-registry/policies/search-block/search-block-apis/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# ⚙ Search Block APIs | ||
|
37 changes: 37 additions & 0 deletions
37
...ndard-registry/policies/search-block/search-block-apis/searching-same-blocks.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Searching Same Blocks | ||
|
||
{% swagger method="post" path="" baseUrl="/analytics/search/block" summary="Search same blocks." %} | ||
{% swagger-description %} | ||
Search same blocks. Only users with the Standard Registry role are allowed to make the request. | ||
{% endswagger-description %} | ||
|
||
{% swagger-parameter in="body" required="true" name="uuid" %} | ||
Filters | ||
{% endswagger-parameter %} | ||
|
||
{% swagger-response status="200: OK" description="Successful Operation" %} | ||
``` | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '#/components/schemas/SearchPoliciesDTO' | ||
``` | ||
{% endswagger-response %} | ||
|
||
{% swagger-response status="401: Unauthorized" description="Unauthorized" %} | ||
|
||
{% endswagger-response %} | ||
|
||
{% swagger-response status="403: Forbidden" description="Forbidden" %} | ||
|
||
{% endswagger-response %} | ||
|
||
{% swagger-response status="500: Internal Server Error" description="Internal Server Error" %} | ||
``` | ||
content: | ||
application/json: | ||
schema: | ||
$ref: '#/components/schemas/InternalServerErrorDTO' | ||
``` | ||
{% endswagger-response %} | ||
{% endswagger %} |
47 changes: 47 additions & 0 deletions
47
docs/guardian/standard-registry/policies/search-block/search-block-using-ui.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# 💻 Search Block using UI | ||
|
||
## 1. Search Example | ||
|
||
Blocks of similar configuration can be searched by clicking on search icon with respect to the block as shown below: | ||
|
||
<figure><img src="../../../../.gitbook/assets/image.png" alt=""><figcaption></figcaption></figure> | ||
|
||
## 2. Search Result | ||
|
||
Search result displays all the policies and its blocks, which have same flow with respect to the base block search. | ||
|
||
<figure><img src="../../../../.gitbook/assets/image (1).png" alt=""><figcaption></figcaption></figure> | ||
|
||
### 2.1 Context | ||
|
||
The search finds and displays the ranked list (most similar on top) of longest continuous matching sequences of blocks surrounding the target block (highlighted). The search considers all dimensions - next/previous, parent/child - to be of equal weight and thus ranks results by the number of blocks in the found ‘similar’ sequence. | ||
|
||
<figure><img src="../../../../.gitbook/assets/image (2).png" alt=""><figcaption></figcaption></figure> | ||
|
||
Additionally, the system compares the configuration of the blocks individually, and displays the %% of similarity to the right of each block in comparison with the corresponding blocks in the base policy. | ||
|
||
### 2.2 Block Configuration | ||
|
||
Right panel of the UI displays the configuration details of the currently selected block as shown below. | ||
|
||
Clicking “Apply” button will transfer (or apply) the configuration of the found block to the corresponding base policy block. | ||
|
||
{% hint style="info" %} | ||
**Note:** Original settings of the base policy block will be lost if ‘Apply’ action is executed. | ||
{% endhint %} | ||
|
||
<figure><img src="../../../../.gitbook/assets/image (3).png" alt=""><figcaption></figcaption></figure> | ||
|
||
### 2.3 Search Results Layout Display | ||
|
||
Search results are displayed as folded groups by Policy (policy name is displayed in the group heading). | ||
|
||
<figure><img src="../../../../.gitbook/assets/image (4).png" alt=""><figcaption></figcaption></figure> | ||
|
||
The results are sorted by (in the correct order): | ||
|
||
1\. The number of the similar blocks in the matching sequence | ||
|
||
2\. Cumulative similarity score (%%) of the blocks | ||
|
||
<figure><img src="../../../../.gitbook/assets/image (5).png" alt=""><figcaption></figcaption></figure> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters