| Summary: | Type name should not appear in return body JSON content | ||
|---|---|---|---|
| Product: | MEC | Reporter: | walter FEATHERSTONE <walter.featherstone> |
| Component: | GS 011 | Assignee: | walter FEATHERSTONE <walter.featherstone> |
| Status: | IN_PROGRESS --- | ||
| Severity: | enhancement | CC: | michele.carignani, sebastian.mueller |
| Priority: | Normal | ||
| Version: | Release 1 | ||
| Target Milestone: | --- | ||
| Hardware: | PC | ||
| OS: | Windows | ||
| Version number of the related document: | V1.1.1 | OpenAPI issue category: | --- |
It's proposed to defer this until the OpenAPI 3.0 descriptions are available, since OpenAPI 2.0 only allows a single return schema. Therefore there's no apparent way to indicate that the return type is optional which is a problem when the return type has a cardinality of 0 to 1 or N, e.g. with respect to ProblemDetails, or even ServiceInfo. |
Example, where the ServiceInfo shouldn’t appear in the response schema: type: array items: type: object properties: ServiceInfo: $ref: '#/definitions/ServiceInfo' Should simply be: schema: type: array items: $ref: '#/definitions/ServiceInfo' And schema: type: object properties: ServiceInfo: $ref: '#/definitions/ServiceInfo' Should simply be: schema: $ref: '#/definitions/ServiceInfo'