[agl-dev-community] Specification proposal for AGL's IDL

["Johann CAHIER" <johann.cahier@xxxxxxx>]

Hello AGL,

As per SPEC-1903, Iot.BZH expressed the urge of :

• Describing JSON data of APIs
• Specifying APIs that throw events (expected, or spurious)
• Describing the internal states and their transitions (state-machines)
• Describing the security model based on permissions
• Being Suitable for the generation of:
  • Documentation in various formats:
    • HTML
    • pdf
    • markdown
    • ...
  • Code skeleton various languages (C, Python...) with optional features;
    • parameter validation
    • marshalling / unmarshalling
    • ...
  • Automated tests
  • ...

  
  

We have been considering existing tool/formalisms, as OpenAPI and AsyncAPI but none was fitting all our expectations.

So we came up with our our custom solution. It's close to other formalisms, but address AGL specific needs.

It's still work-in-progess, so every feedback is welcome !

Please find attached the link to the document [0]

Johann CAHIER

[0] Here is the document : https://github.com/iotbzh/afbidl/blob/master/spec-afbidl.md

_._,_._,_

---

Links:

You receive all messages sent to this group.

View/Reply Online (#8113) | Reply To Group | Reply To Sender | Mute This Topic | New Topic

Your Subscription | Contact Group Owner | Unsubscribe [list-automotive-discussions82@xxxxxxxxxxx]

_._,_._,_