Skip to content

Commit aeef612

Browse files
danielpeintnerTallTedegekorkan
authored
Propose user story for XML data mapping (#2109)
* refactor: propose user story for XML data mapping * Update planning/work-items/analysis/analysis-data-mapping.md Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com> * Update planning/work-items/analysis/analysis-data-mapping.md Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com> * Update planning/work-items/analysis/analysis-data-mapping.md Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com> * Update planning/work-items/analysis/analysis-data-mapping.md Co-authored-by: Ege Korkan <egekorkan@gmail.com> * Update planning/work-items/analysis/analysis-data-mapping.md Co-authored-by: Ege Korkan <egekorkan@gmail.com> * Update planning/work-items/analysis/analysis-data-mapping.md Co-authored-by: Ege Korkan <egekorkan@gmail.com> * Update planning/work-items/analysis/analysis-data-mapping.md Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com> * Update planning/work-items/analysis/analysis-data-mapping.md Co-authored-by: Ege Korkan <egekorkan@gmail.com> * Update planning/work-items/analysis/analysis-data-mapping.md * add existing solution in openapi --------- Co-authored-by: Ted Thibodeau Jr <tthibodeau@openlinksw.com> Co-authored-by: Ege Korkan <egekorkan@gmail.com>
1 parent b0fbec2 commit aeef612

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

planning/work-items/analysis/analysis-data-mapping.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,27 @@ Also known as: Mapping TD elements to messages
4646
- Impact Type: Have a clear way to support services that are hard or impossible to describe nowadays
4747
- Linked Use Cases or Categories: TBD
4848

49+
2. XML data exchange
50+
51+
- **Who:** TD designer of a Thing with XML data exchange.
52+
- **What:** Want to describe XML payloads in TDs (TD uses JSON Schema to describe payload data) and automatically validate XML payloads (WoT implementations use JSON Schema to validate payload data)
53+
- Impossible to describe XML data accurately (i.e., there is no 1:1 mapping between JSON schema and XML schema)
54+
- XML and/or JSON in memory while data on the wire (mapping between JSON and XML)
55+
- See discussions in https://github.com/w3c/wot-binding-templates/issues/139
56+
- **Why:** So I can include Things (including in existing solutions) that use XML as payload content type in the WoT
57+
58+
- Sentence: **As a** developer, **I need** to support data exchange other than JSON (e.g., XML).
59+
- Process Stakeholders:
60+
- Submitter: Daniel Peintner
61+
- Specification Writers: Daniel Peintner
62+
- Implementation Volunteers: Daniel Peintner
63+
- Impacted People: TD Designers and Consumer application developers.
64+
- Impact Type: Have a **standardized** way to describe XML data in TDs which increases addressable Things without impacting existing implementations
65+
- Linked Use Cases or Categories: TBD
66+
4967
## Existing Solutions
5068

51-
TBD
69+
- OpenAPI 3.2 with XML Payload Description: https://github.com/OAI/OpenAPI-Specification/pull/4592
5270

5371
## Summarized Problem
5472

0 commit comments

Comments
 (0)