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

Spec AS registration format #460

Open
non-Jedi opened this issue Apr 12, 2019 · 2 comments
Open

Spec AS registration format #460

non-Jedi opened this issue Apr 12, 2019 · 2 comments
Labels
A-Application-Services Issues affecting the AS API clarification An area where the expected behaviour is understood, but the spec could do with being more explicit

Comments

@non-Jedi
Copy link
Contributor

Currently the spec leaves the format of AS registration files completely
undefined. In fact, the current verbiage doesn't even make it completely clear
that the registration is an actual on-disk file. In practice, of course, synapse
requires a yaml registration file. The spec needs to clarify that either:

  1. Registration is an entirely implementation-specific thing where
    implementations should expect the following set of fields.
  2. Registration is a physical file with a specific format (yaml, JSON, toml, etc.).

If we go for option 2, I would strongly push that we not enshrine any text
format other than JSON in the spec and that yaml not be an acceptable format for
this.

This issue would also be resolved by matrix-org/matrix-spec-proposals#3807.

@turt2live
Copy link
Member

From the spec:

The registration is represented by a series of key-value pairs, which this specification will present as YAML.

It's intentionally vague here to allow for homeservers to support alternative formats if they so please, such as JSON APIs. Not all homeservers are required to use a YAML file on a disk.

Does this clear up the confusion a bit?

@turt2live turt2live added A-Application-Services Issues affecting the AS API clarification An area where the expected behaviour is understood, but the spec could do with being more explicit question Further information is requested labels Apr 13, 2019
@non-Jedi
Copy link
Contributor Author

non-Jedi commented Apr 13, 2019

Not confusion on my part; I saw that it was intentionally open-ended, but to me those registration files are part of the public AS api, so requiring AS to potentially provide multiple formats of registration for different homeservers doesn't sit right.

@turt2live turt2live removed the question Further information is requested label Apr 13, 2019
@richvdh richvdh transferred this issue from matrix-org/matrix-spec-proposals Mar 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Application-Services Issues affecting the AS API clarification An area where the expected behaviour is understood, but the spec could do with being more explicit
Projects
None yet
Development

No branches or pull requests

2 participants