Skip to content

Create a machine readable protocol specification #332

Description

@akafredperry

Is your feature request related to a problem? Please describe.

We would like a structured specification of the protocol specification that captures the following...

  • key structure
  • key metadata
  • commands (verbs and parameters)
  • responses
  • documentation

Describe the solution you'd like

We don't want something too formal (e.g. EBNF). It should be straight forward for humans and machines to read.
The solution should be a neutral format for which there is support in many programming languages (suggestion is JSON).
The source for the model should be
https://github.com/atsign-foundation/at_client_sdk/blob/trunk/packages/at_commons/lib/src/verb/syntax.dart
BUT ideally we don't want to use regexes in the specification.
We should however be able to generate the regexes, in fact the initial POC should demonstrate generating code such as syntax.dart and protocol_specification.md.
Ultimately we want to be able to generate (or allow LLMs to generate) codecs / command builders etc.

Describe alternatives you've considered

No response

Additional context

No response

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions