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

templates: Proposed VSC->IFEX changes #63

Merged
merged 1 commit into from
May 31, 2024
Merged

Conversation

gunnarx
Copy link
Collaborator

@gunnarx gunnarx commented Aug 10, 2023

These are proposed changes to the descriptions (.md) and template files (.tpl) for DTDL, Protobuf, and SDS.

The approach is to replace VSC with IFEX when talking about the language features and format, and to keep VSC when talking about the Vehicle Service Catalog as the source of the example files. In some cases when VSC or IFEX is superfluous, the word has simply been deleted for simplicity.

The changes are trivial, so copyright statements (2022 Robert Bosch GmbH) do not need to be amended.

@gunnarx
Copy link
Collaborator Author

gunnarx commented Aug 10, 2023

If you want to take a look @erikbosch ... Otherwise it's nothing major, just making things "up to date" with the current. I have not heavily tested these templates, but they seem to generate output OK. (Protobuf is the one that is likely to get some more work on it soon, for the reason of supporting gRPC.)

@gunnarx gunnarx requested a review from erikbosch August 10, 2023 12:41

FIXME: LINK

https://github.com/COVESA/vehicle_service_catalog#native-data-types) to [DTDL datatype](https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/dtdlv2.md#primitive-schemas).
Copy link
Collaborator Author

@gunnarx gunnarx Aug 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apparently the document has been updated, but if the code is based on the older spec, then maybe the link should not be updated? (not sure...)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh I noticed, that's not the link that needs fixing, it is the "VSC" link. I'll set the PR to draft in the meantime.

FIXME: LINK

[IFEX Structs](https://github.com/COVESA/vehicle_service_catalog#namespace-list-object-structs) can be represented as [DTDL Interface Object Schemas](https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/dtdlv2.md#interface-schemas).

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here...

@gunnarx gunnarx marked this pull request as draft August 10, 2023 13:14
@gunnarx
Copy link
Collaborator Author

gunnarx commented Aug 23, 2023

Rebased and adding Interface node support. Not much tested yet.

@@ -1,17 +1,17 @@
{# Protobuf template #}
{# (C) 2022 Robert Bosch GmbH #}
// protobuf/gRPC definition generated using template: protobuf.tpl
// protobuf code generated by protobuf.tpl
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"generated by AST_protobuf.tpl"?

These are proposed changes to the descriptions (.md) and template files
(.tpl) for DTDL, Protobuf, and SDS.

The approach is to replace VSC with IFEX when talking about the language
features and format, and to keep VSC when talking about the Vehicle
Service Catalog as the source of the example files.  In some cases
when VSC or IFEX is superfluous, the word has simply been deleted
for simplicity.

The changes are trivial, so copyright statements (2022 Robert Bosch
GmbH) do not need to be amended.

Signed-off-by: Gunnar Andersson <gunnar@nospam@novaspring.eu>
@gunnar-mb
Copy link
Collaborator

gunnar-mb commented May 31, 2024

Rebased and fixed incorrect URLs / links, and the remark about AST_protobuf.tpl

@gunnar-mb gunnar-mb marked this pull request as ready for review May 31, 2024 15:35
@gunnar-mb
Copy link
Collaborator

The updated template is still mostly untested but since there is no more new input/usage of DTDL right now, I'll merge it for now and if interest picks up later, then it can be further refined.

@gunnar-mb gunnar-mb merged commit e00ca12 into master May 31, 2024
11 checks passed
@gunnar-mb gunnar-mb deleted the update_bosch_templates branch May 31, 2024 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants