before-interop / anomalieAdresse

Ce protocole permet le traitement d'une demande de création ou de modification d'adresses immeuble dans les IPE
https://before-interop.github.io/anomalieAdresse/
1 stars 6 forks source link

Fix: Avoid inline schemas #124

Closed hamdan-ahmad-lb closed 6 days ago

hamdan-ahmad-lb commented 2 weeks ago

Inline schemas are schemas defined within a component, such as parameter, requestBody, response, and so on, but are not declared globally in the components/schemas section.

In general, inline schemas are not encouraged in code generators and API portal generators since their names are inferred from the parent node in which they are defined inline.

Names inferred in this manner may not be user-friendly and may conflict with other names resulting in name duplications. As a result, it is recommended that the schemas be defined globally in the components/schemas section with unique names and be used as references throughout the specification.

ref: OpenAPI Best Practices by APIMatic, 3rd point