ClusterCockpit/cc-backend
1
0
Fork 0
mirror of https://github.com/ClusterCockpit/cc-backend synced 2025-07-24 13:16:08 +02:00
Code Issues Packages Releases Activity

Move /search code to routerConfig, add simple docs for searchbar

Browse Source
This commit is contained in:
Christoph Kluge
2023-02-09 10:11:11 +01:00
parent 1873c6a87d
commit 641affbbdf
3 changed files with 89 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/searchbar.md Normal file
View File

@@ -0,0 +1,24 @@
## Docs for ClusterCockpit Searchbar
### Usage
* Searchtags are implemented as `type:<query>` search-string
* Types `jobId, jobName, projectId, username` for roles `admin` and `support`
* Types `jobId, jobName` for role `user`
* Examples:
* `jobName:myJob12`
* `jobId:123456`
* `username:abcd100`
* If no searchTag used: Best guess search with the following hierarchy
* `jobId -> username -> projectId -> jobName`
* Simple HTML Error if ...
* Best guess search fails -> 'Not Found'
* Query `type` is unknown
* More than two colons in string -> 'malformed'
* Spaces trimmed (both for searchTag and queryString)
* ` job12` == `job12`
* `projectID : abcd ` == `projectId:abcd`
* jobId-Query now redirects to table
* Allows multiple jobs from different systems, but with identical job-id to be found
* jobName-Query works with a part of the jobName-String (e.g. jobName:myjob for jobName myjob_cluster1)
* JobName GQL Query is resolved as matching the query as a part of the whole metaData-JSON in the SQL DB.