Skip to content

Commit 56f5342

Browse files
author
Mikalai Radchuk
committed
Change formatting in the "Catalog queries" doc
Current syntax uses definition lists [1] from mkdocs-material. However it relies on a tailing space after a colon to work. E.g. the whole line becomes `: ` and it is prone to errors because: 1. It is easy to overlook a space which is part of formatting. 2. Many editors remove tailing spaces at the end of lines. 3. We will be adding more definition lists into this docs to explain placeholders such as `<package_name>`. With nested definition lists markdown of this document going to be very difficult to manage. This commit switches from definition lists to unordered list. [1]: https://squidfunk.github.io/mkdocs-material/reference/lists/#using-definition-lists Signed-off-by: Mikalai Radchuk <[email protected]>
1 parent 9c394f1 commit 56f5342

File tree

1 file changed

+39
-49
lines changed

1 file changed

+39
-49
lines changed

docs/howto/catalog-queries.md

Lines changed: 39 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -13,61 +13,51 @@ curl -k https://localhost:8443/catalogs/operatorhubio/api/v1/all | <query>
1313

1414
## Package queries
1515

16-
Available packages in a catalog
17-
:
18-
``` terminal
19-
jq -s '.[] | select( .schema == "olm.package")'
20-
```
21-
22-
Packages that support `AllNamespaces` install mode and do not use webhooks
23-
24-
:
25-
``` terminal
26-
jq -c 'select(.schema == "olm.bundle") | {"package":.package, "version":.properties[] | select(.type == "olm.bundle.object").value.data | @base64d | fromjson | select(.kind == "ClusterServiceVersion" and (.spec.installModes[] | select(.type == "AllNamespaces" and .supported == true) != null) and .spec.webhookdefinitions == null).spec.version}'
27-
```
28-
29-
Package metadata
30-
:
31-
``` terminal
32-
jq -s '.[] | select( .schema == "olm.package") | select( .name == "<package_name>")'
33-
```
34-
35-
Catalog blobs in a package
36-
:
37-
``` terminal
38-
jq -s '.[] | select( .package == "<package_name>")'
39-
```
16+
* Available packages in a catalog:
17+
``` terminal
18+
jq -s '.[] | select( .schema == "olm.package")'
19+
```
20+
21+
* Packages that support `AllNamespaces` install mode and do not use webhooks:
22+
``` terminal
23+
jq -c 'select(.schema == "olm.bundle") | {"package":.package, "version":.properties[] | select(.type == "olm.bundle.object").value.data | @base64d | fromjson | select(.kind == "ClusterServiceVersion" and (.spec.installModes[] | select(.type == "AllNamespaces" and .supported == true) != null) and .spec.webhookdefinitions == null).spec.version}'
24+
```
25+
26+
* Package metadata:
27+
``` terminal
28+
jq -s '.[] | select( .schema == "olm.package") | select( .name == "<package_name>")'
29+
```
30+
31+
* Catalog blobs in a package:
32+
``` terminal
33+
jq -s '.[] | select( .package == "<package_name>")'
34+
```
4035
4136
## Channel queries
4237
43-
Channels in a package
44-
:
45-
``` terminal
46-
jq -s '.[] | select( .schema == "olm.channel" ) | select( .package == "<package_name>") | .name'
47-
```
38+
* Channels in a package:
39+
``` terminal
40+
jq -s '.[] | select( .schema == "olm.channel" ) | select( .package == "<package_name>") | .name'
41+
```
4842
49-
Versions in a channel
50-
:
51-
``` terminal
52-
jq -s '.[] | select( .package == "<package_name>" ) | select( .schema == "olm.channel" ) | select( .name == "<channel_name>" ) | .entries | .[] | .name'
53-
```
43+
* Versions in a channel:
44+
``` terminal
45+
jq -s '.[] | select( .package == "<package_name>" ) | select( .schema == "olm.channel" ) | select( .name == "<channel_name>" ) | .entries | .[] | .name'
46+
```
5447
55-
Latest version in a channel and upgrade path
56-
:
57-
``` terminal
58-
jq -s '.[] | select( .schema == "olm.channel" ) | select ( .name == "<channel>") | select( .package == "<package_name>")'
59-
```
48+
* Latest version in a channel and upgrade path:
49+
``` terminal
50+
jq -s '.[] | select( .schema == "olm.channel" ) | select ( .name == "<channel>") | select( .package == "<package_name>")'
51+
```
6052
6153
## Bundle queries
6254
63-
Bundles in a package
64-
:
65-
``` terminal
66-
jq -s '.[] | select( .schema == "olm.bundle" ) | select( .package == "<package_name>") | .name'
67-
```
55+
* Bundles in a package:
56+
``` terminal
57+
jq -s '.[] | select( .schema == "olm.bundle" ) | select( .package == "<package_name>") | .name'
58+
```
6859
69-
Bundle dependencies and available APIs
70-
:
71-
``` terminal
72-
jq -s '.[] | select( .schema == "olm.bundle" ) | select ( .name == "<bundle_name>") | select( .package == "<package_name>")'
73-
```
60+
* Bundle dependencies and available APIs:
61+
``` terminal
62+
jq -s '.[] | select( .schema == "olm.bundle" ) | select ( .name == "<bundle_name>") | select( .package == "<package_name>")'
63+
```

0 commit comments

Comments
 (0)