belgif / rest-guide

REST Guidelines of Belgian government institutions
https://www.belgif.be/specification/rest/api-guide/
Apache License 2.0
24 stars 4 forks source link

Naming convention for types for partial resource #120

Open pvdbosch opened 1 year ago

pvdbosch commented 1 year ago

Partial resource representations are used to refer to a resource within another one's representation and often contain:

Should we standardize the naming of the OpenApi types?

Some examples:

  "gender": {
    "description": "female",
    "code": 1
  },

  "deliveryMethod": {
     "code": "deliveredAtHome", 
     "href": "/refData/deliveryMethods/deliveredAtHome"
  },

  "store": {
     "id": 789, 
     "name": "Pet Store Brussels",
     "href": "/stores/789"
  }

I sometimes see the use of suffixes "Reference", "Link", "Summary", ... for the openapi types