Hateoas CollectionModel - Do we follow HAL or OpenAPI 3.0 specification?

[chrisatrotter]

When creating a Hateoas CollectionModel with springdoc-openapi, then the naming "content" and "links" is given within the Schema as specified by OpenAPI 3.0. However, these names do not follow the convention of the HAL Specification which is "_embedded" and "_links".

OpenAPI 3.0 Specification

HAL Specification

Describe the solution you'd like

It would be nice to change the OpenAPI 3.0 Specification of "content" and "links" to "_embedded" and "_links". It would be more natural to follow the HAL Specification as this is specific for Hateoas 1.0. Result shown below:

"components":{
    "schemas": {
      "CollectionModel«EntityModel«RelatedCode»»":{ 
         "type":"object",
         "properties":{ 
            "_embedded":{ 
               ...
            },
            "_links":{ 
               ...
            }
         },
         "title":"CollectionModel«EntityModel«RelatedCode»»"
      }
   }
}

Links to the specifications

• OpenAPI 3.0 Specification: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#response-object
• HAL Specification: https://tools.ietf.org/html/draft-kelly-json-hal-08#section-4.1

[bnasslahsen]

@chrisatrotter,

You can have a look at this issue:

• Hateoas fields names mismatch #401

It depends on your RepositoryRestConfiguration who can use or not Hal As DefaultJsonMediaType.

[chrisatrotter]

@bnasslahsen, thank you for taking the time! It solved the issue! Keep up the great work!