Skip to content

Enhancing ActionData - #221

Open
TuThoThai wants to merge 8 commits into
v2.3-wipfrom
sx_cr_actiondata_enhancement
Open

TuThoThai wants to merge 8 commits into
v2.3-wipfrom
sx_cr_actiondata_enhancement

Conversation

@TuThoThai

Copy link
Copy Markdown
Collaborator
  • Change in Prompt to embed MIME content type
  • Addition of Url with a specific type to embed MIME content type and language
  • All served with an example

This PR is to be discussed and merged before PR #210 that adds PublishToAudioAction. To include Url in ActionData addresses @skinkie comment

- Change in `Prompt` to embed MIME content type
- Addition of `Url` with a specific type to embed MIME content type and language
- All served with an example
@TuThoThai TuThoThai added SX For everything SIRI-SX Needs CEN documentation Update These require CEN documentation update to match XSD & examples labels May 18, 2026
@TuThoThai TuThoThai added this to the v2.3 milestone May 18, 2026
@skinkie

skinkie commented May 18, 2026

Copy link
Copy Markdown
Contributor

I would prefer that the Prompt itself is not changed in function. Hence if an organisation wants to do something with predefined markup that is fine, they can use Url text/html or application/xhtml+xml or maybe even something like image/svg+xml but lets keep the sane default just plain text.

@TuThoThai

Copy link
Copy Markdown
Collaborator Author

Since Url points to a different resource, regardeless of its type, I thought it would be nice to allow people to have a bit more choices in the format for text content in Prompt while taking advantage of adding the content-type attribute.

@thbar thbar left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I did a first round mostly on "details". I will mull over the general design & see if I can comment more on the overall structure (need more time).

Comment thread xsd/siri_model/siri_situationActions.xsd Outdated
Comment thread examples/siri_exm_SX/exm_situationExchange_responsewithpromptandurl.xml Outdated
@@ -0,0 +1,131 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) Copyright 2005-2012 CEN SIRI -->

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
<!-- (C) Copyright 2005-2012 CEN SIRI -->
<!-- (C) Copyright 2005-2026 CEN SIRI -->

Comment thread xsd/siri_utility/siri_types.xsd Outdated
@TuThoThai

Copy link
Copy Markdown
Collaborator Author

During the SIRI-SX meeting of 19 may 2026, the assessment was that the PR is not yet ready for review. Discussed changes / paints points are to be addressed.
Moving back this PR to draft to work on it and make it ready for review on 12 June 2026

@TuThoThai
TuThoThai marked this pull request as draft May 19, 2026 13:34
TuThoThai and others added 2 commits July 15, 2026 19:34
- Adding the element Url in ActionDataStructure
- Adding the attribute contentType for both Prompt and Url elements
- Defining the enumeration related to contentType
@TuThoThai
TuThoThai marked this pull request as ready for review July 15, 2026 17:34
@TuThoThai

Copy link
Copy Markdown
Collaborator Author

Based on feedback from the meeting of 19 May 2026, I made the following changes in the PR:

  • keeping the addition of the element Url in ActionDataStructure
  • adding the attribute contentType in both Prompt and Url
  • making the attribute contentType into an enumeration with a very limited list of allowed MIME types

…ndurl.xml

delete faulty example from previous try
@TuThoThai
TuThoThai requested a review from thbar July 16, 2026 06:56
Comment thread xsd/siri_model/siri_situationActions.xsd

@TuThoThai TuThoThai left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

As per discussion with @haeckerbaer, @skinkie and @thbar on 16 July 2026

Comment thread xsd/siri_utility/siri_types.xsd
@ue71603

ue71603 commented Aug 17, 2026

Copy link
Copy Markdown
Collaborator

What is blocking this one?

haeckerbaer
haeckerbaer previously approved these changes Sep 16, 2026
Comment thread xsd/siri_utility/siri_types.xsd Outdated
@TuThoThai

Copy link
Copy Markdown
Collaborator Author

It PR was approved at the SIRI plenary of 29 September 2026, so we can merge it.

@thbar thbar left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

2 suggestions to remove some content types.

For video (already in use in UK as mentioned by @tim-rivett, not sure which content type would be fine at this point).

Also: @TuThoThai I didn't find the place where we advertise that the content-type/language combination must be unique !

Comment on lines +252 to +256
<xsd:enumeration value="image/bmp">
<xsd:annotation>
<xsd:documentation>Bitmap image file</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
<xsd:enumeration value="image/bmp">
<xsd:annotation>
<xsd:documentation>Bitmap image file</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>

I would have a hard-time seeing anyone broadcasting BMP files (big & uncompressed)

Comment on lines +247 to +251
<xsd:enumeration value="audio/x-wav">
<xsd:annotation>
<xsd:documentation>Waveform audio file</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
<xsd:enumeration value="audio/x-wav">
<xsd:annotation>
<xsd:documentation>Waveform audio file</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>

WAV files are usually (if not always) uncompressed, so I would believe there would rarely be broadcasted, too.

Comment on lines +232 to +236
<xsd:enumeration value="audio/midi">
<xsd:annotation>
<xsd:documentation>MIDI audio file</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
<xsd:enumeration value="audio/midi">
<xsd:annotation>
<xsd:documentation>MIDI audio file</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>

I would remove this one. WDYT @Aurige ; if a prompt is supposed to be a message, MIDI is probably out of scope here.

Comment on lines +237 to +241
<xsd:enumeration value="audio/mp4">
<xsd:annotation>
<xsd:documentation>MP4 audio file</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
<xsd:enumeration value="audio/mp4">
<xsd:annotation>
<xsd:documentation>MP4 audio file</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="audio/mpeg">
<xsd:annotation>
<xsd:documentation>MPEG audio file (e.g., mp3)</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="audio/mp4">
<xsd:annotation>
<xsd:documentation>MP4 audio file</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>

@@ -0,0 +1,126 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) Copyright 2005-2012 CEN SIRI -->

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
<!-- (C) Copyright 2005-2012 CEN SIRI -->
<!-- (C) Copyright 2005-2026 CEN SIRI -->

@@ -0,0 +1,126 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- (C) Copyright 2005-2012 CEN SIRI -->
<Siri xmlns="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:d2="http://datex2.eu/schema/2_0RC1/2_0" version="2.0" xsi:schemaLocation="http://www.siri.org.uk/siri ../../xsd/siri.xsd">

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
<Siri xmlns="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:d2="http://datex2.eu/schema/2_0RC1/2_0" version="2.0" xsi:schemaLocation="http://www.siri.org.uk/siri ../../xsd/siri.xsd">
<Siri xmlns="http://www.siri.org.uk/siri" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:d2="http://datex2.eu/schema/2_0RC1/2_0" version="2.3.0" xsi:schemaLocation="http://www.siri.org.uk/siri ../../xsd/siri.xsd">

Comment thread xsd/siri_model/siri_situationActions.xsd
<xsd:element name="Prompt" type="PromptType" minOccurs="0" maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>Display prompt for presenting action to user. (Unbounded since SIRI 2.0)</xsd:documentation>
<xsd:documentation>Display prompt for presenting action to user. (Unbounded since SIRI 2.0). Possibility to add attributs on the type of prompt, and its language (+v2.3)</xsd:documentation>

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
<xsd:documentation>Display prompt for presenting action to user. (Unbounded since SIRI 2.0). Possibility to add attributs on the type of prompt, and its language (+v2.3)</xsd:documentation>
<xsd:documentation>Display prompt for presenting action to user. (Unbounded since SIRI 2.0). Possibility to add attributes on the type of prompt, and its language (+v2.3)</xsd:documentation>

</xsd:element>
<xsd:element name="Url" type="ContentURI" minOccurs="0" maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>Direct link to the content to be published or broadcaseted as is (e.g., pre-recorded message, image, etc.).</xsd:documentation>

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
<xsd:documentation>Direct link to the content to be published or broadcaseted as is (e.g., pre-recorded message, image, etc.).</xsd:documentation>
<xsd:documentation>Direct link to the content to be published or broadcast as is (e.g., pre-recorded message, image, etc.).</xsd:documentation>

</xsd:complexType>
<xsd:simpleType name="ContentTypeEnumeration">
<xsd:annotation>
<xsd:documentation>Allowed values for contenType attribute (+v2.3)</xsd:documentation>

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
<xsd:documentation>Allowed values for contenType attribute (+v2.3)</xsd:documentation>
<xsd:documentation>Allowed values for contentType attribute (+v2.3)</xsd:documentation>

<xsd:minInclusive value="0"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="PromptType">

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
<xsd:complexType name="PromptType">
<xsd:complexType name="PromptStructure">

I think that this would be more idiomatic re: existing use of complex types in SIRI (to be verified).

</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
<xsd:complexType name="ContentURI">

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
<xsd:complexType name="ContentURI">
<xsd:complexType name="ContentUriStructure">

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs CEN documentation Update These require CEN documentation update to match XSD & examples SX For everything SIRI-SX

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants