Rename ErrorMessage to Problem, split into specific types, revise output #203

ue71603 · 2022-06-01T18:56:08Z

Renamed ErrorMessage to Problem in accordance to RFC 7807, Code to Type, Text to Title and added Details and LogData
Added dedicated ProblemStructures for each request, enumerating the possible types, some of which were previously only defined in the documentation, some not defined at all.
Added the Problem element to PlaceResultStructure and TripInfoResultStructure
Added the Problem element to FareResultStructure so StopFareResult and StaticFareResult may also contain one and removed it from TripFareResult and MultiTripFareResult
Renamed some problem types (in comparison to the former documentation):
- FARES_* to FARE_*
- MULTIPOINTTRIP_NOTALLPOINTSCOVERED to TRIP_MULTIPOINT_NOTALLPOINTSCOVERED
- MULTIPOINTTRIP_TOOMANYPOINTS to TRIP_MULTIPOINT_TOOMANYPOINTS

Fixes: #111

sgrossberndt

We have to discuss this change again.

This list currently only consists of StopEventResponse from the documentation, which now is OJPStopEventDelivery. But apparently when I removed unused structures in 0168dcd4 it was overlooked these ErrorMessages are not part of the output at all.
I wonder now whether this was the correct choice back then to simply remove these structures - how are error messages regarding a whole response transported now? The current state seems to only be able to transport an error message for a single StopEventResult, but not for the whole OJPStopEventDelivery. Do we have to re-add ErrorMessage at a base delivery level?
Is Code in ErrorMessageStructure the correct place to document all the codes for all the responses or should they rather be documented each in the ErrorMessage where they may occur, e.g. https://github.com/VDVde/OJP/blob/changes_for_v1.1/OJP/OJP_StopEvents.xsd#L194
Currently there are only the error codes of some stopEvent documented in the xsd in this commit, the documentation has a lot more, e.g. STOPEVENT_LASTSERVICEOFTHISLINE, FARES_STOPPOINTUNKNOWN, ... which are missing here.

OJP/OJP_Common.xsd

ue71603 · 2022-08-25T21:58:39Z

@sgrossberndt You have a lengthy comment here. It seems it does not relate to this change. Should we discuss it in a separate issue? Can you create it then?

We have to discuss this change again.

This list currently only consists of StopEventResponse from the documentation, which now is OJPStopEventDelivery. But apparently when I removed unused structures in 0168dcd4 it was overlooked these ErrorMessages are not part of the output at all.
I wonder now whether this was the correct choice back then to simply remove these structures - how are error messages regarding a whole response transported now? The current state seems to only be able to transport an error message for a single StopEventResult, but not for the whole OJPStopEventDelivery. Do we have to re-add ErrorMessage at a base delivery level?

Is Code in ErrorMessageStructure the correct place to document all the codes for all the responses or should they rather be documented each in the ErrorMessage where they may occur, e.g. https://github.com/VDVde/OJP/blob/changes_for_v1.1/OJP/OJP_StopEvents.xsd#L194

Currently there are only the error codes of some stopEvent documented in the xsd in this commit, the documentation has a lot more, e.g. STOPEVENT_LASTSERVICEOFTHISLINE, FARES_STOPPOINTUNKNOWN, ... which are missing here.

sgrossberndt · 2022-08-30T08:33:59Z

No, this lengthy comment is exactly about this change. There is no use merging this pull request before we have discussed the points in this comment. In order to be able to find it for the discussion I will add it to the issue though.

ue71603 · 2022-10-18T17:33:55Z

For the single result level ErrorMessage can be used.
We have ServiceDelivery/ErrorCondition for general high level errors:
We also have OJPExchancePointDelivery/ErrorCondition:

This is still very abstract.

One idea would be for Delivery level errors would be to add a ServiceDeliveryErrorGroup. It that for simplicities sake, I would like to put multiple ErrorMessageStructures. However, this is not possible, because DeliveryStatusGroup belongs to Siri

I will try to put it into the ServiceResponseContextGroup

Then I would like to formalize ErrorMessageStructure (but not having a different one per request/response:

Code as Enum
Text for the description
LogDatan as xs:string

The code is then expanded from

OJP specification
SIRI
TRIAS

ue71603 · 2022-10-18T17:46:12Z

SIRI is already included in the ErrorCondition, but was not fully helpful
Started copying codes from the specification. @trurlurl could you continue? The eumeration is ErrorCodeEnumeration in OJP_Commons.xsd and in the specification you search for "possible errors"
@sgrossberndt It seems to me that TRIAS uses the same codes in the specification document as OJP. But I only have the 1.2 file. Is the 1.4 out already?

sgrossberndt · 2022-10-19T07:22:46Z

You can find TRIAS releases at https://github.com/VDVde/TRIAS/releases, most recent is v1.3 but v1.4 will be released in the near future

…into error_messeges_in_xsd

herlitze · 2022-11-09T15:47:17Z

I am also torn. I see the proposed solution with a structure but subcategories in the enum name as a good compromise

skinkie

I still wonder why we change ErrorMessage to "Problem" maybe this choice of words can be explained.

ue71603 · 2022-11-24T14:17:23Z

Part of the commit message: https://datatracker.ietf.org/doc/html/rfc7807 and also. Errorstructures by Service (and perhaps a general one) and have a complete list as annex to the standard rendered by the documentation engine.

ue71603 · 2022-12-06T16:39:24Z

@sgrossberndt updated: Is this ok for you now?

# Conflicts: # docs/generated/OJP.html

* `OJP_Common.xsd` now only contains the `ProblemDetailGroup` shared by all `ProblemStructure`s * Renamed `ProblemStructure` to `OJPGenericProblemStructure` and moved it to `OJP_RequestSupport.xsd` as it is only used there * Moved the `Problem` element to `FareResultStructure` so `StopFareResult` and `StaticFareResult` may also contain a problem and removed it from `TripFareResult` and `MultiTripFareResult` * Moved the problem definitions to the bottom of each file and have them in the same order everywhere * Renamed some problem types: * `OTHER` to `OJPGENERIC_OTHER` * `FARES_*` to `FARE_*` * `MULTIPOINTTRIP_NOTALLPOINTSCOVERED` to `TRIP_MULTIPOINT_NOTALLPOINTSCOVERED` * `MULTIPOINTTRIP_TOOMANYPOINTS` to `TRIP_MULTIPOINT_TOOMANYPOINTS` * Added the missing `Problem` element for the `TripInfoProblemStructure` * fixed some typos

sgrossberndt

Proposal for commit message when squashing:

Renamed ErrorMessage to Problem in accordance to RFC 7807, Code to Type, Text to Title and added Details and LogData
Added dedicated ProblemStructures for each request, enumerating the possible types, some of which were previously only defined in the documentation, some not defined at all.
Added the Problem element to PlaceResultStructure and TripInfoResultStructure
Added the Problem element to FareResultStructure so StopFareResult and StaticFareResult may also contain one and removed it from TripFareResult and MultiTripFareResult
Renamed some problem types (in comparison to the former documentation):
- FARES_* to FARE_*
- MULTIPOINTTRIP_NOTALLPOINTSCOVERED to TRIP_MULTIPOINT_NOTALLPOINTSCOVERED
- MULTIPOINTTRIP_TOOMANYPOINTS to TRIP_MULTIPOINT_TOOMANYPOINTS

OJP/OJP_Places.xsd

added the error messages from the documenation

1227fab

ue71603 added this to the v2.0 milestone Jun 1, 2022

ue71603 requested review from skinkie, sgrossberndt and trurlurl June 1, 2022 18:56

Travis CI update [skip ci]

14be2a2

ue71603 mentioned this pull request Jun 1, 2022

Error messages in xsd? #111

Closed

sgrossberndt changed the title ~~added the error messages from the documenation~~ Add error messages from the documentation Aug 23, 2022

Fix errors, formatting and translation

67ea1f0

sgrossberndt force-pushed the error_messeges_in_xsd branch from 575aace to 67ea1f0 Compare August 23, 2022 09:14

Travis CI update [skip ci]

97040c6

sgrossberndt requested changes Aug 23, 2022

View reviewed changes

OJP/OJP_Common.xsd Outdated Show resolved Hide resolved

ue71603 added enhancement New feature or request documentation to be disussed labels Sep 15, 2022

ue71603 removed the to be disussed label Oct 18, 2022

Error handling new

f7e7fa3

sgrossberndt force-pushed the error_messeges_in_xsd branch from 755bb0f to c732bf9 Compare October 19, 2022 07:07

Added the error codes from the documentation

b541ecb

sgrossberndt force-pushed the error_messeges_in_xsd branch from c291fcf to b541ecb Compare October 19, 2022 07:14

ue71603 and others added 5 commits October 26, 2022 21:43

Merge branch 'error_messeges_in_xsd' of https://github.com/VDVde/OJP …

36c9e27

…into error_messeges_in_xsd

ErrorMessage => Problem (according to RFC

bcdefe2

Travis CI update [skip ci]

2892deb

Error codes added

a7ac8db

Travis CI update [skip ci]

0b7f0af

ue71603 added the to be disussed label Nov 20, 2022

skinkie previously approved these changes Nov 24, 2022

View reviewed changes

reorganised error codes

279898d

ue71603 dismissed skinkie’s stale review via 279898d December 6, 2022 16:37

Travis CI update [skip ci]

b6202f5

ue71603 requested review from sgrossberndt and skinkie December 6, 2022 16:38

sgrossberndt and others added 3 commits December 7, 2022 10:13

Merge branch 'changes_for_v1.1' into error_messeges_in_xsd

69c0c1c

# Conflicts: # docs/generated/OJP.html

Travis CI update [skip ci]

5a1cc52

sgrossberndt changed the title ~~Add error messages from the documentation~~ Rename ErrorMessage to Problem, split into specific types, revise output Dec 7, 2022

sgrossberndt previously approved these changes Dec 7, 2022

View reviewed changes

ue71603 mentioned this pull request Dec 7, 2022

Problem handling to be added to the new services after merging the PR on problems #270

Closed

herlitze previously approved these changes Dec 12, 2022

View reviewed changes

Merge branch 'changes_for_v1.1' into error_messeges_in_xsd

7b5a062

skinkie reviewed Dec 15, 2022

View reviewed changes

OJP/OJP_Places.xsd Outdated Show resolved Hide resolved

Revert aligning order of attributes in WaitDuration

8ac1783

sgrossberndt dismissed stale reviews from herlitze and themself via 8ac1783 December 15, 2022 14:42

sgrossberndt approved these changes Dec 15, 2022

View reviewed changes

sgrossberndt requested review from skinkie and herlitze December 15, 2022 14:45

skinkie approved these changes Dec 16, 2022

View reviewed changes

sgrossberndt merged commit de4cf82 into changes_for_v1.1 Dec 16, 2022

sgrossberndt deleted the error_messeges_in_xsd branch December 16, 2022 09:09

trurlurl added doc updated and removed documentation labels Jan 14, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename ErrorMessage to Problem, split into specific types, revise output #203

Rename ErrorMessage to Problem, split into specific types, revise output #203

ue71603 commented Jun 1, 2022 •

edited by sgrossberndt

Loading

sgrossberndt left a comment

ue71603 commented Aug 25, 2022

sgrossberndt commented Aug 30, 2022

ue71603 commented Oct 18, 2022

ue71603 commented Oct 18, 2022

sgrossberndt commented Oct 19, 2022

herlitze commented Nov 9, 2022

skinkie left a comment

ue71603 commented Nov 24, 2022

ue71603 commented Dec 6, 2022

sgrossberndt left a comment

Rename ErrorMessage to Problem, split into specific types, revise output #203

Rename ErrorMessage to Problem, split into specific types, revise output #203

Conversation

ue71603 commented Jun 1, 2022 • edited by sgrossberndt Loading

sgrossberndt left a comment

Choose a reason for hiding this comment

ue71603 commented Aug 25, 2022

sgrossberndt commented Aug 30, 2022

ue71603 commented Oct 18, 2022

ue71603 commented Oct 18, 2022

sgrossberndt commented Oct 19, 2022

herlitze commented Nov 9, 2022

skinkie left a comment

Choose a reason for hiding this comment

ue71603 commented Nov 24, 2022

ue71603 commented Dec 6, 2022

sgrossberndt left a comment

Choose a reason for hiding this comment

ue71603 commented Jun 1, 2022 •

edited by sgrossberndt

Loading