Skip to content

Commit f056c37

Browse files
update client/openapi/trustd.yaml
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 52fdc56 commit f056c37

File tree

1 file changed

+28
-173
lines changed

1 file changed

+28
-173
lines changed

client/openapi/trustd.yaml

Lines changed: 28 additions & 173 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,9 @@ paths:
3333
parameters:
3434
- name: q
3535
in: query
36-
description: |-
36+
description: |
3737
Query for advisories defined using the following EBNF grammar (ISO/IEC 14977):
38+
```text
3839
(* Query Grammar - EBNF Compliant *)
3940
query = ( values | filter ) , { "&" , query } ;
4041
values = value , { "|" , value } ;
@@ -46,13 +47,13 @@ paths:
4647
escaped_char = "\" , special_char ;
4748
normal_char = ? any character except '&', '|', '=', '!', '~', '>', '<', '\' ? ;
4849
special_char = "&" | "|" | "=" | "!" | "~" | ">" | "<" | "\" ;
49-
(* Examples:
50-
- Simple filter: title=example
51-
- Multiple values filter: title=foo|bar|baz
52-
- Complex filter: modified>2024-01-01
53-
- Combined query: title=foo&average_severity=high
54-
- Escaped characters: title=foo\&bar
55-
*)
50+
```
51+
Examples:
52+
- Simple filter: title=example
53+
- Multiple values filter: title=foo|bar|baz
54+
- Complex filter: modified>2024-01-01
55+
- Combined query: title=foo&average_severity=high
56+
- Escaped characters: title=foo\\&bar
5657
required: false
5758
schema:
5859
type: string
@@ -462,80 +463,6 @@ paths:
462463
required: true
463464
schema:
464465
type: string
465-
- name: q
466-
in: path
467-
description: |
468-
EBNF grammar for the _q_ parameter:
469-
```text
470-
q = ( values | filter ) { '&' q }
471-
values = value { '|', values }
472-
filter = field, operator, values
473-
operator = "=" | "!=" | "~" | "!~" | ">=" | ">" | "<=" | "<"
474-
value = (* any text but escape special characters with '\' *)
475-
field = (* must match an entity attribute name *)
476-
```
477-
Any values in a _q_ will result in a case-insensitive "full
478-
text search", effectively producing an OR clause of LIKE
479-
clauses for every string-ish field in the resource being
480-
queried.
481-
482-
Examples:
483-
- `foo` - any field containing 'foo'
484-
- `foo|bar` - any field containing either 'foo' OR 'bar'
485-
- `foo&bar` - some field contains 'foo' AND some field contains 'bar'
486-
487-
A _filter_ may also be used to constrain the results. The
488-
filter's field name must correspond to one of the resource's
489-
attributes. If it doesn't, an error will be returned
490-
containing a list of the valid fields for that resource.
491-
492-
The value 'null' is treated specially for [Not]Equal filters:
493-
it returns resources on which the field isn't set. Use the
494-
LIKE operator, `~`, to match a literal "null" string. Omit the
495-
value to match an empty string.
496-
497-
Examples:
498-
- `name=foo` - entity's _name_ matches 'foo' exactly
499-
- `name~foo` - entity's _name_ contains 'foo', case-insensitive
500-
- `name~foo|bar` - entity's _name_ contains either 'foo' OR 'bar', case-insensitive
501-
- `name=` - entity's _name_ is the empty string, ''
502-
- `name=null` - entity's _name_ isn't set
503-
- `published>3 days ago` - date values can be "human time"
504-
505-
Multiple full text searches and/or filters should be
506-
'&'-delimited -- they are logically AND'd together.
507-
508-
- `red hat|fedora&labels:type=cve|osv&published>last wednesday 17:00`
509-
510-
Fields corresponding to JSON objects in the database may use a
511-
':' to delimit the column name and the object key,
512-
e.g. `purl:qualifiers:type=pom`
513-
514-
Any operator or special character, e.g. '|', '&', within a
515-
value should be escaped by prefixing it with a backslash.
516-
required: true
517-
schema:
518-
type: string
519-
- name: sort
520-
in: path
521-
description: |
522-
EBNF grammar for the _sort_ parameter:
523-
```text
524-
sort = field [ ':', order ] { ',' sort }
525-
order = ( "asc" | "desc" )
526-
field = (* must match the name of entity's attributes *)
527-
```
528-
The optional _order_ should be one of "asc" or "desc". If
529-
omitted, the order defaults to "asc".
530-
531-
Each _field_ name must correspond to one of the columns of the
532-
table holding the entities being queried. Those corresponding
533-
to JSON objects in the database may use a ':' to delimit the
534-
column name and the object key,
535-
e.g. `purl:qualifiers:type:desc`
536-
required: true
537-
schema:
538-
type: string
539466
- name: offset
540467
in: query
541468
description: |-
@@ -751,7 +678,7 @@ paths:
751678
get:
752679
tags:
753680
- analysis
754-
summary: Retrieve SBOM components (packages) by name, Package URL, or CPE.
681+
summary: Retrieve latest SBOM components (packages) by name, Package URL, or CPE.
755682
operationId: getLatestComponent
756683
parameters:
757684
- name: key
@@ -760,80 +687,6 @@ paths:
760687
required: true
761688
schema:
762689
type: string
763-
- name: q
764-
in: path
765-
description: |
766-
EBNF grammar for the _q_ parameter:
767-
```text
768-
q = ( values | filter ) { '&' q }
769-
values = value { '|', values }
770-
filter = field, operator, values
771-
operator = "=" | "!=" | "~" | "!~" | ">=" | ">" | "<=" | "<"
772-
value = (* any text but escape special characters with '\' *)
773-
field = (* must match an entity attribute name *)
774-
```
775-
Any values in a _q_ will result in a case-insensitive "full
776-
text search", effectively producing an OR clause of LIKE
777-
clauses for every string-ish field in the resource being
778-
queried.
779-
780-
Examples:
781-
- `foo` - any field containing 'foo'
782-
- `foo|bar` - any field containing either 'foo' OR 'bar'
783-
- `foo&bar` - some field contains 'foo' AND some field contains 'bar'
784-
785-
A _filter_ may also be used to constrain the results. The
786-
filter's field name must correspond to one of the resource's
787-
attributes. If it doesn't, an error will be returned
788-
containing a list of the valid fields for that resource.
789-
790-
The value 'null' is treated specially for [Not]Equal filters:
791-
it returns resources on which the field isn't set. Use the
792-
LIKE operator, `~`, to match a literal "null" string. Omit the
793-
value to match an empty string.
794-
795-
Examples:
796-
- `name=foo` - entity's _name_ matches 'foo' exactly
797-
- `name~foo` - entity's _name_ contains 'foo', case-insensitive
798-
- `name~foo|bar` - entity's _name_ contains either 'foo' OR 'bar', case-insensitive
799-
- `name=` - entity's _name_ is the empty string, ''
800-
- `name=null` - entity's _name_ isn't set
801-
- `published>3 days ago` - date values can be "human time"
802-
803-
Multiple full text searches and/or filters should be
804-
'&'-delimited -- they are logically AND'd together.
805-
806-
- `red hat|fedora&labels:type=cve|osv&published>last wednesday 17:00`
807-
808-
Fields corresponding to JSON objects in the database may use a
809-
':' to delimit the column name and the object key,
810-
e.g. `purl:qualifiers:type=pom`
811-
812-
Any operator or special character, e.g. '|', '&', within a
813-
value should be escaped by prefixing it with a backslash.
814-
required: true
815-
schema:
816-
type: string
817-
- name: sort
818-
in: path
819-
description: |
820-
EBNF grammar for the _sort_ parameter:
821-
```text
822-
sort = field [ ':', order ] { ',' sort }
823-
order = ( "asc" | "desc" )
824-
field = (* must match the name of entity's attributes *)
825-
```
826-
The optional _order_ should be one of "asc" or "desc". If
827-
omitted, the order defaults to "asc".
828-
829-
Each _field_ name must correspond to one of the columns of the
830-
table holding the entities being queried. Those corresponding
831-
to JSON objects in the database may use a ':' to delimit the
832-
column name and the object key,
833-
e.g. `purl:qualifiers:type:desc`
834-
required: true
835-
schema:
836-
type: string
837690
- name: offset
838691
in: query
839692
description: |-
@@ -1331,8 +1184,9 @@ paths:
13311184
parameters:
13321185
- name: q
13331186
in: query
1334-
description: |-
1187+
description: |
13351188
Query for advisories defined using the following EBNF grammar (ISO/IEC 14977):
1189+
```text
13361190
(* Query Grammar - EBNF Compliant *)
13371191
query = ( values | filter ) , { "&" , query } ;
13381192
values = value , { "|" , value } ;
@@ -1344,13 +1198,13 @@ paths:
13441198
escaped_char = "\" , special_char ;
13451199
normal_char = ? any character except '&', '|', '=', '!', '~', '>', '<', '\' ? ;
13461200
special_char = "&" | "|" | "=" | "!" | "~" | ">" | "<" | "\" ;
1347-
(* Examples:
1348-
- Simple filter: title=example
1349-
- Multiple values filter: title=foo|bar|baz
1350-
- Complex filter: modified>2024-01-01
1351-
- Combined query: title=foo&average_severity=high
1352-
- Escaped characters: title=foo\&bar
1353-
*)
1201+
```
1202+
Examples:
1203+
- Simple filter: title=example
1204+
- Multiple values filter: title=foo|bar|baz
1205+
- Complex filter: modified>2024-01-01
1206+
- Combined query: title=foo&average_severity=high
1207+
- Escaped characters: title=foo\\&bar
13541208
required: false
13551209
schema:
13561210
type: string
@@ -3047,8 +2901,9 @@ paths:
30472901
parameters:
30482902
- name: q
30492903
in: query
3050-
description: |-
2904+
description: |
30512905
Query for advisories defined using the following EBNF grammar (ISO/IEC 14977):
2906+
```text
30522907
(* Query Grammar - EBNF Compliant *)
30532908
query = ( values | filter ) , { "&" , query } ;
30542909
values = value , { "|" , value } ;
@@ -3060,13 +2915,13 @@ paths:
30602915
escaped_char = "\" , special_char ;
30612916
normal_char = ? any character except '&', '|', '=', '!', '~', '>', '<', '\' ? ;
30622917
special_char = "&" | "|" | "=" | "!" | "~" | ">" | "<" | "\" ;
3063-
(* Examples:
3064-
- Simple filter: title=example
3065-
- Multiple values filter: title=foo|bar|baz
3066-
- Complex filter: modified>2024-01-01
3067-
- Combined query: title=foo&average_severity=high
3068-
- Escaped characters: title=foo\&bar
3069-
*)
2918+
```
2919+
Examples:
2920+
- Simple filter: title=example
2921+
- Multiple values filter: title=foo|bar|baz
2922+
- Complex filter: modified>2024-01-01
2923+
- Combined query: title=foo&average_severity=high
2924+
- Escaped characters: title=foo\\&bar
30702925
required: false
30712926
schema:
30722927
type: string

0 commit comments

Comments
 (0)