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

Complete or remove JSON Schema of the Core Profile #120

Open
benfrancis opened this issue Nov 8, 2021 · 8 comments
Open

Complete or remove JSON Schema of the Core Profile #120

benfrancis opened this issue Nov 8, 2021 · 8 comments
Assignees

Comments

@benfrancis
Copy link
Member

There's currently an incomplete section of the specification called JSON Schema of the Core Profile.

This section either needs to be completed, or removed, before publication.

Note that if the WoT Core Data Model section is reduced or removed as I have proposed in #10 then this section may be of limited value and the JSON schema provided by the WoT Thing Description specification would be sufficient.

benfrancis added a commit to benfrancis/wot-profile that referenced this issue Nov 8, 2021
@egekorkan
Copy link
Contributor

I think there will be and has to more restrictions that the schema of the TD. For example, checking for http:// in form href values.

@mlagally
Copy link
Contributor

I completely agree with @egekorkan that we need a JSON Schema for automatic validation.
The primary goal of the Profile spec is to drive interoperability and we need additional constraints that make that happen.
The added value of the Profile is way more than just providing an unambiguous the HTTP protocol binding.

@mlagally
Copy link
Contributor

arch call on 25.11.:
consensus that we add a JSON schema. This should rely on the Schema from the TD and provide additional rules/validations/constraints, if there are any.
The set of constraints needs to be consolidated first, before we can define the schema.

@mlagally
Copy link
Contributor

tentatively assigning to @egekorkan and @FadySalama and hoping to get their help.

@egekorkan
Copy link
Contributor

I agree that the contraints should be agreed on first since there is discussion on nearly every detail. After that, we can write a script that takes the TD schema creates another schema that has more constraints

@mlagally
Copy link
Contributor

mlagally commented Sep 7, 2022

Defer to Profile 1.1.

@benfrancis
Copy link
Member Author

benfrancis commented Mar 14, 2024

Note that the Core Profile now no longer exists. JSON schemas could be created for each published profile, but that may have limited value because profiles can not be completely described by a JSON schema. I would suggest closing this issue.

@egekorkan
Copy link
Contributor

I would still see the value of having a JSON Schema for each profile, especially considering that they will be a subset of TD later on. However, a set of linting rules like with Spectral might fit better since a JSON Schema will always do a strict validation (which is too assertive in some cases)

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

4 participants