Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Discussion] Feedback on current specification formats #83

Open
joshmossas opened this issue Aug 8, 2024 · 0 comments
Open

[Discussion] Feedback on current specification formats #83

joshmossas opened this issue Aug 8, 2024 · 0 comments

Comments

@joshmossas
Copy link
Member

joshmossas commented Aug 8, 2024

This issue is to be a space to discussion the current Arri App Definition and Arri Type Definition specifications. I really want to lock this down as it will be used as the intermediate representation of applications across all languages. Any feedback is welcome.

In my view these documents should:

  • make it easy to generate type-safe clients
  • be easy to auto-generate from code
  • have consistent syntax

Non-goals:

  • make it easy to be hand written by humans (it's okay if this happens as a side-affect I suppose)

It'd also like to explore what adding support from non-http transport would look like. Currently these assume assume a request response model, however this isn't the case with all applications. Realtime apps using something like websockets may just be designed in a send and forget way. What would representing something like that look like? If we want to support it.

References to the current specifications can be found here:

Ideally this is something that once finalized never changes. So we should really take time to consider all the use cases we want to support.

@joshmossas joshmossas pinned this issue Aug 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant