GFA-DIU / OpenSource4Impact

Open source checklist
https://gfa-diu.github.io/OpenSource4Impact
Creative Commons Zero v1.0 Universal
2 stars 1 forks source link

Interoperability standards #1

Open fretchen opened 1 year ago

fretchen commented 1 year ago

We constantly have discussions about appropiate interoperability standards. I did not see a simple solution on this until now:

I think that there should be something on interoperability. But what ?

avvertix commented 1 year ago

I think here is worth mentioning that interoperability can be viewed from different angles. From the perspective of a guideline I think the following are the key ones:

  1. Data Export. Getting data out of the system, this can be realized in form of file based exports or APIs
  2. Data Import. Getting data inside the system, this can be realized in form of file based exchange or by offering APIs

Personally I don't think we should mention specific standards in the guidelines, but only general approaches and the fact that the most appropriate standard for data exchange should be researched based on the use cases.

We can, probably, suggest to take into account interoperability from day one by introducing early an API or a way to programmatically run import/exports.

GFA-DIU commented 1 year ago

As I understand the comments, may be we can settle on two aspects:

fretchen commented 1 year ago

So I summarize from what I understand:

Point 1

Point 2 It is recommended to base yourself on existing data structures. Examples:

Is this fair ?

avvertix commented 1 year ago

@GFA-DIU the phrasing of the two aspects are in-line with what I was trying to express. @fretchen your summary is totally right. Have a properly documented API, have ways of import/export data then if there are standards those ways and documentation should come in a standard format.