[Moims-dai] OAIS-IF observations

[Massimo Schiavon]

Here is a summary of the observations presented in the today's meeting.

JSON payload Inconsistencies:

  1.
Almost all field names use PascalCase except DataObject.size, InformationPackage.PDI.Provenance.DataObject.size and InformationPackage.version
  2.
The field InformationPackage.PDI.Fixity.RepresentationInformation.IdentifierType has a value of "URL" all the others use the more generic type "URI"
  3.
In the GIP example InformationPackage.InformationObject.RepInfo.OtherRI.OrGroup field is a JSON Object but in AIP example InformationPackage.InformationObject.RepresentationInformation.AndGroup.OtherRI.OrGroup is a JSON Array
  4.
In the GIP example, field InformationPackage.InformationObject.RepInfo instead of InformationPackage.InformationObject.RepresentationInformation

General suggestions:

  1.
Use RFC 7807 - Problem Details for HTTP APIs (ietf.org)<https://datatracker.ietf.org/doc/html/rfc7807> to represent errors
  2.
Avoid HATEOAS, stick to maturity level 2 of Richardson Maturity Model<https://en.wikipedia.org/wiki/Richardson_Maturity_Model#Level_3:_Hypermedia_controls>
  3.
Endpoint paths should return a single type of data. For instance use an endpoint for collection of objects (ex. /pdis) and another for accessing a specific object (ex. /pdis/123 where 123 is th ID of the desired PDI). The first returns a list of PDI objects, the second a PDI object
  4.
It's ok to provide JSON Schema spec for JSON payloads, but the OpenAPI spec is also needed

Attached:

  1.
SpecificAdapterController.java - example of using OpenAPI and Spring MVC annotations to produce APIs and OpenAPI specification
  2.
application.yml - Spring Boot properties I use to configure Spring and SpringDoc

Best regards
Massimo



[cid:2e8064bf-85e1-4b21-b15a-0b2bc8370a43]
Massimo Schiavon​​​​
Engineering
 ‑
IT Systems Architect
[cid:afb31aa2-7aec-41b9-9977-05276cce6b0a]
+393401254872<tel:+393401254872>
Deda Cloud srl
 ‑
PADOVA

www.deda.cloud<http://www.deda.cloud/>
https://www.linkedin.com/deda-cloud/<https://www.linkedin.com/showcase/deda-cloud>
[Scopri di più]<https://www.officeautomation.soiel.it/il-punto-sulla-cybersecurity-secondo-deda-cloud/>
Le informazioni contenute in questo messaggio di posta elettronica sono riservate e confidenziali e ne e' vietata la diffusione in qualsiasi modo o forma. Qualora Lei non fosse la persona destinataria del presente messaggio, La invitiamo a non diffonderlo e ad eliminarlo, dandone gentilmente comunicazione al mittente.

The information included in this e-mail and any attachments are confidential and may also be privileged. If you are not the correct recipient, you are kindly requested to notify the sender immediately, to cancel it and not to disclose the contents to any other person.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mailman.ccsds.org/pipermail/moims-dai/attachments/20240430/551d0fdc/attachment-0001.htm>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: image945227.png
Type: image/png
Size: 12985 bytes
Desc: image945227.png
URL: <http://mailman.ccsds.org/pipermail/moims-dai/attachments/20240430/551d0fdc/attachment-0003.png>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: image763475.png
Type: image/png
Size: 396 bytes
Desc: image763475.png
URL: <http://mailman.ccsds.org/pipermail/moims-dai/attachments/20240430/551d0fdc/attachment-0004.png>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: image893480.png
Type: image/png
Size: 64811 bytes
Desc: image893480.png
URL: <http://mailman.ccsds.org/pipermail/moims-dai/attachments/20240430/551d0fdc/attachment-0005.png>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: SpecificAdapterController.java
Type: application/octet-stream
Size: 2949 bytes
Desc: SpecificAdapterController.java
URL: <http://mailman.ccsds.org/pipermail/moims-dai/attachments/20240430/551d0fdc/attachment-0002.obj>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: application.yml
Type: application/octet-stream
Size: 262 bytes
Desc: application.yml
URL: <http://mailman.ccsds.org/pipermail/moims-dai/attachments/20240430/551d0fdc/attachment-0003.obj>