@@ -462,80 +462,6 @@ paths:
462462 required : true
463463 schema :
464464 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
539465 - name : offset
540466 in : query
541467 description : |-
@@ -751,7 +677,7 @@ paths:
751677 get :
752678 tags :
753679 - analysis
754- summary : Retrieve SBOM components (packages) by name, Package URL, or CPE.
680+ summary : Retrieve latest SBOM components (packages) by name, Package URL, or CPE.
755681 operationId : getLatestComponent
756682 parameters :
757683 - name : key
@@ -760,80 +686,6 @@ paths:
760686 required : true
761687 schema :
762688 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
837689 - name : offset
838690 in : query
839691 description : |-
0 commit comments