docs(openapi): standardize inco-sheets list and search responses to IncoShort and remove short parameter

This commit is contained in:
Jérémy Munsch 2026-09-18 10:06:45 +02:00
parent 5b2c0e58ce
commit 2b8aae51af
Signed by: forge-joniko
GPG key ID: D7EFE2F5CB6CC0E4

View file

@ -142,10 +142,10 @@ paths:
get:
tags:
- IncoSheets
summary: Liste paginée des fiches produits INCO
summary: Liste paginée des fiches produits INCO (format court)
description: |
Retourne la liste paginée des fiches produits INCO.
Prend en charge le filtrage par marques (`brands`), la date de modification (`since`), la projection au format court (`short=true`), ainsi que le tri et la pagination.
Retourne la liste paginée des fiches produits INCO au format court (IncoShort).
Prend en charge le filtrage par marques (`brands`), la date de modification (`since`), ainsi que le tri et la pagination.
operationId: listIncoSheets
parameters:
- $ref: "#/components/parameters/Page"
@ -154,7 +154,6 @@ paths:
- $ref: "#/components/parameters/Limit"
- $ref: "#/components/parameters/Since"
- $ref: "#/components/parameters/Brands"
- $ref: "#/components/parameters/ShortProjection"
- $ref: "#/components/parameters/IncoSortBy"
- $ref: "#/components/parameters/SortDirection"
responses:
@ -254,15 +253,13 @@ paths:
get:
tags:
- IncoSheets
summary: Recherche de fiches INCO par identifiant (motif SQL LIKE)
summary: Recherche de fiches INCO par identifiant (format court)
description: |
Recherche des fiches INCO dont l'ID correspond à un motif (`incoIdLike`).
Prend également en charge la projection au format court (`short=true`).
Recherche des fiches INCO dont l'ID correspond à un motif (`incoIdLike`) au format court (IncoShort).
operationId: searchIncoSheets
parameters:
- $ref: "#/components/parameters/IncoIdLike"
- $ref: "#/components/parameters/Brands"
- $ref: "#/components/parameters/ShortProjection"
responses:
"200":
description: Résultats de recherche INCO.
@ -557,15 +554,6 @@ components:
pattern: '^[A-Z]{3}\d{2}$'
example: ["LGL01", "MCQ01"]
ShortProjection:
name: short
in: query
required: false
description: Retourne la projection courte si true.
schema:
type: boolean
default: false
IncoSortBy:
name: sortBy
in: query
@ -1870,30 +1858,14 @@ components:
IncoListResponse:
type: object
description: Enveloppe de réponse pour la liste des fiches INCO.
required:
- incoSheets
- pagination
properties:
incoSheets:
type: array
description: Collection des fiches INCO (format complet ou court).
items:
anyOf:
- $ref: "#/components/schemas/Inco"
- $ref: "#/components/schemas/IncoShort"
pagination:
$ref: "#/components/schemas/PaginationMeta"
IncoShortListResponse:
type: object
description: Enveloppe de réponse pour la liste courte des fiches INCO.
description: Enveloppe de réponse pour la liste des fiches INCO (format court).
required:
- incoSheets
- pagination
properties:
incoSheets:
type: array
description: Collection des fiches INCO au format court.
items:
$ref: "#/components/schemas/IncoShort"
pagination: