-
Notifications
You must be signed in to change notification settings - Fork 60
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
Move Schema Definitions from JSON to swagger.yaml #331
Comments
Hello, will 4.0 be a new version in terms of breaking changes or is this just some cleanup regarding the |
Hey @NKnusperer, it'll be a new version sometime in the future. There have been a few new features, and also some breaking changes. We don't yet know when this will be released, but the work for moving away from the JSON schemas to the Swagger file won't be made for currently released versions. |
Thank you @GeorgDangl. |
Well you can also just include the fields already in your endpoints, clients should ignore any fields they don't know about. So including extra information right now should just work, and those fields can be consumed by clients that know about it. |
We've discussed it in the group, we want to get rid of the embedded JSON schema files for all objects and instead only rely on a single
swagger.yaml
file. For this, we'll have to do a bit of work:feature/swagger-spec
branchswagger.yaml
changesmaster
branchswagger.yaml
file with all changes since the 3.0 release (its current state)We need to sync those items:
84af26d#diff-ac8d0a54775f67811b0c24e33fd2fa997d59a30af88b696789daf117e3095391
3885f36
-> Custom fields ✔
d92ce0d
-> Change url parameter names ✔
5cbce2f
-> Topic relations ✔
3b6653c
-> parent / child relations ✔
c2584b0
-> Viewpoint audit info ✔
fa9aa93
-> translucency ✔
5659983
-> Remove BIM snippet ✔
f4f5035
-> Topic files in viewpoints ✔
0f3e266
-> id and name properties ✔
6ce1ee5
-> markers ✔
edfde64
-> Main viewpoint guid ✔
The text was updated successfully, but these errors were encountered: