An OpenAPI Parameter Object describes non-body input accepted by an operation. It records a parameter’s name, location, requiredness, and schema, making requests clearer for consumers and tools. section 6.4.3 section 6.6.1
Path and query parameters
A product lookup declares its path identifier explicitly: /products/{productReference} uses name: productReference, in: path, and required: true. A search operation can declare keywords and category with in: query; optional parameters may omit required or set it to false. section 6.4.3 section 6.6.1
Listing 17.10 Creating a group of query parameters
components:
parameters:
Pagination:
name: pagination #1
description: | #2
Pagination parameters (`.../?next=s00999&limit=10`)
in: query
schema:
type: object #3
properties: #4
next:
description: Next page cursor
type: string
limit:
description: Number of elements per page
type: number
A reusable object-valued query parameter groups pagination inputs such as next and limit, while its description clarifies the serialized request format and tool-support trade-off. section 17.3.3
