Discussion Content-Type - Githubissues

3lbits / CIM4NoUtility

CIM for the Norwegian Power Utility

Creative Commons Attribution Share Alike 4.0 International

20 stars 7 forks source link

Discussion Content-Type #299

Closed ThomasRanvikEriksen closed 7 months ago

ThomasRanvikEriksen commented 1 year ago

We want to discuss the use of content-type. The 2 categories we want now is Reading and IntervalReading

Something like this (We might want to skip the company part. Do we want version?)?

application/vnd.{company}.{category}.{version}+{format}

Examples:

application/vnd.lede.cim-reading.v17.0+json
application/vnd.lede.cim-intervalreading.v17.0+json

Best Practice:

Content-type: application/vnd.company.category+xml
Content-type: application/vnd.company.category+html
Content-type: application/vnd.company.category+json
Content-type: application/vnd.company.category+jsonld

Internal discussion:

Version is smart to add for change management
Company might not be needed