Fix open API docs for excludeInstallStatus query param (#130986)

This commit is contained in:
Kyle Pollich 2022-04-26 12:49:07 -04:00 committed by GitHub
parent ffe1cdddc7
commit caedd861b0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 459 additions and 117 deletions

File diff suppressed because it is too large Load diff

View file

@ -186,13 +186,16 @@ paths:
operationId: list-all-packages
parameters:
- in: query
name: includeInstallStatus
name: excludeInstallStatus
schema:
type: boolean
default: false
description: >-
Whether to include the install status of each package. Defaults to
false to allow for caching of package requests.
Whether to exclude the install status of each package. Enabling this
option will opt in to caching for the response via `cache-control`
headers. If you don't need up-to-date installation info for a package,
and are querying for a list of available packages, providing this flag
can improve performance substantially.
/epm/packages/_bulk:
post:
summary: Packages - Bulk install

View file

@ -11,8 +11,12 @@ get:
operationId: list-all-packages
parameters:
- in: query
name: includeInstallStatus
name: excludeInstallStatus
schema:
type: boolean
default: false
description: Whether to include the install status of each package. Defaults to false to allow for caching of package requests.
description: >-
Whether to exclude the install status of each package. Enabling this option will opt in to
caching for the response via `cache-control` headers. If you don't need up-to-date installation
info for a package, and are querying for a list of available packages, providing this flag can
improve performance substantially.