Skip to content

Commit

Permalink
JA October 2024 monthly update (#556)
Browse files Browse the repository at this point in the history 
* Update schedule reference

* Update RT revision history

* Revert "Update RT revision history"

This reverts commit aeb507c.

* Update Realtime revision history

* Update Proto.md and Proto file

* Update feed entities - trip modifications

* Update RT reference

* Mini changes

---------

Co-authored-by: Frédéric Simard <frederic-contractor@mobilitydata.org>
  • Loading branch information
@Sergiodero @fredericsimard
Sergiodero and fredericsimard authored Dec 17, 2024
1 parent db104ba commit 8593c3d
Show file tree
Hide file tree
Showing 6 changed files with 94 additions and 47 deletions.
4 changes: 4 additions & 0 deletions docs/ja/documentation/realtime/change-history/revision-history.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

### 改訂履歴

#### 2024年10月

* 旅行の変更に関する明確化と小さな変更。[ディスカッション](https://github.com/google/transit/pull/497)を参照してください。

#### 2024年3月

* 旅程変更を採用しました。[ディスカッション](https://github.com/google/transit/pull/403)を参照してください。
Expand Down
12 changes: 6 additions & 6 deletions docs/ja/documentation/realtime/feed-entities/trip-modifications.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ GTFS-TripModifications を通じて作成された便は、指定された各 `t
## Linkage to TripUpdates (TripUpdatesへのリンク)

* TripUpdate は、TripUpdate の `TripDescriptor` 内の `ModifiedTripSelector` を使用して提供する必要があります。
* TripUpdate が代替の旅程を参照する場合、消費者は静的 GTFS が TripModifications (代替の停留所の `arrival_time`、`departure_time`、`stop_sequence`、`stop_id` など) で変更されたかのように動作する必要があります。
* `ModifiedTripSelector` を提供する場合、`TripDescriptor` の他のフィールドは空のままにしておく必要があります。これは、`ModifiedTripSelector` 値を探していない消費者による混乱を避けるためです。
* `ModifiedTripSelector` を使用して更新を提供する TripUpdate フィードには、TripModifications をサポートしていないクライアントを対象とする TripUpdate も含める必要があります。つまり、TripUpdate は 2 つあるはずです。1 つは変更された便 (`TripModifications` あり) を持つクライアント用、もう 1 つは変更されていない元の GTFS (`TripModifications` なし) を持つクライアント用です。
* `ModifiedTripSelector` を含む TripUpdate を提供することが、代替の停留所で予測を作成する唯一の方法です。
* TripUpdate が代替の旅程を参照する場合、消費者は静的 GTFS が TripModifications (代替の停留所の `arrival_time`、`departure_time`、`stop_sequence`、`stop_id` など) で変更されたかのように動作する必要があります。
* `ModifiedTripSelector` を指定する場合、`ModifiedTripSelector` 値を探していないコンシューマーによる混乱を避けるため、 `TripDescriptor`の`trip_id`、 `route_id`、` `direction_id`、` `start_time`、 `start_date`フィールドは空のままにしておく必要があります。
* `ModifiedTripSelector` を使用して更新を提供する TripUpdate フィードには、TripModifications をサポートしていないクライアントを対象とする TripUpdate も含める必要があります。つまり、TripUpdate は 2 つあるはずです。1 つは変更された便 (`TripModifications` あり) を持つクライアント用、もう 1 つは変更されていない元の GTFS (`TripModifications` なし) を持つクライアント用です。
* `ModifiedTripSelector` を含む TripUpdate を提供することが、代替の停留所で予測を作成する唯一の方法です。
* そのような TripUpdate が見つからない場合、元の `trip_id` の TripUpdate が変更後の便に適用されます。
* この場合、使用される静的 GTFS 情報は、TripModifications が適用される前の静的 GTFS からのものである必要があります。
* 以前の便と新しい変更後の便の間の共通の停留所ではリアルタイム情報を利用できますが、代替の停留所では ETA は利用できません。
* この場合、使用される静的 GTFS 情報は、TripModifications が適用される前の静的 GTFS からのものである必要があります。
* 以前の便と新しい変更後の便の間の共通の停留所ではリアルタイム情報を利用できますが、代替の停留所では ETA は利用できません。

## 変更

Expand Down
51 changes: 34 additions & 17 deletions docs/ja/documentation/realtime/gtfs-realtime.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ message TripUpdate {
// In order to provide departure_occupancy_status without either arrival or
// departure StopTimeEvents, ScheduleRelationship should be set to NO_DATA.
optional VehiclePosition.OccupancyStatus departure_occupancy_status = 7;

// The relation between the StopTimeEvents and the static schedule.
enum ScheduleRelationship {
// The vehicle is proceeding in accordance with its static schedule of
Expand Down Expand Up @@ -252,7 +252,7 @@ message TripUpdate {
UNSCHEDULED = 3;
}
optional ScheduleRelationship schedule_relationship = 5
[default = SCHEDULED];
[default = SCHEDULED];

// Provides the updated values for the stop time.
// NOTE: This message is still experimental, and subject to change. It may be formally adopted in the future.
Expand Down Expand Up @@ -641,29 +641,29 @@ message Alert {

// Severity of this alert.
enum SeverityLevel {
UNKNOWN_SEVERITY = 1;
INFO = 2;
WARNING = 3;
SEVERE = 4;
UNKNOWN_SEVERITY = 1;
INFO = 2;
WARNING = 3;
SEVERE = 4;
}

optional SeverityLevel severity_level = 14 [default = UNKNOWN_SEVERITY];

// TranslatedImage to be displayed along the alert text. Used to explain visually the alert effect of a detour, station closure, etc. The image must enhance the understanding of the alert. Any essential information communicated within the image must also be contained in the alert text.
// The following types of images are discouraged : image containing mainly text, marketing or branded images that add no additional information.
// NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.
optional TranslatedImage image = 15;
optional TranslatedImage image = 15;

// Text describing the appearance of the linked image in the `image` field (e.g., in case the image can't be displayed
// or the user can't see the image for accessibility reasons). See the HTML spec for alt image text - https://html.spec.whatwg.org/#alt.
// NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.
optional TranslatedString image_alternative_text = 16;


// Description of the cause of the alert that allows for agency-specific language; more specific than the Cause. If cause_detail is included, then Cause must also be included.
// NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.
optional TranslatedString cause_detail = 17;

// Description of the effect of the alert that allows for agency-specific language; more specific than the Effect. If effect_detail is included, then Effect must also be included.
// NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.
optional TranslatedString effect_detail = 18;
Expand Down Expand Up @@ -810,7 +810,7 @@ message TripDescriptor {
CANCELED = 3;

// Should not be used - for backwards-compatibility only.
REPLACEMENT = 5 [deprecated=true];
REPLACEMENT = 5 [deprecated = true];

// An extra trip that was added in addition to a running schedule, for example, to replace a broken vehicle or to
// respond to sudden passenger load. Used with TripUpdate.TripProperties.trip_id, TripUpdate.TripProperties.start_date,
Expand Down Expand Up @@ -848,7 +848,24 @@ message TripDescriptor {

// The trip_id from the GTFS feed that is modified by the modifications_id
optional string affected_trip_id = 2;

// The initially scheduled start time of this trip instance, applied to the frequency based modified trip. Same definition as start_time in TripDescriptor.
optional string start_time = 3;

// The start date of this trip instance in YYYYMMDD format, applied to the modified trip. Same definition as start_date in TripDescriptor.
optional string start_date = 4;

// The extensions namespace allows 3rd-party developers to extend the
// GTFS Realtime Specification in order to add and evaluate new features and
// modifications to the spec.
extensions 1000 to 1999;

// The following extension IDs are reserved for private use by any organization.
extensions 9000 to 9999;
}

// Linkage to any modifications done to this trip (shape changes, removal or addition of stops).
// If this field is provided, the `trip_id`, `route_id`, `direction_id`, `start_time`, `start_date` fields of the `TripDescriptor` MUST be left empty, to avoid confusion by consumers that aren't looking for the `ModifiedTripSelector` value.
optional ModifiedTripSelector modified_trip = 7;

// The extensions namespace allows 3rd-party developers to extend the
Expand Down Expand Up @@ -1028,7 +1045,7 @@ message Shape {
// See https://developers.google.com/protocol-buffers/docs/proto#specifying_field_rules
// NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.
optional string shape_id = 1;

// Encoded polyline representation of the shape. This polyline must contain at least two points.
// For more information about encoded polylines, see https://developers.google.com/maps/documentation/utilities/polylinealgorithm
// This field is required as per reference.md, but needs to be specified here optional because "Required is Forever"
Expand All @@ -1052,7 +1069,7 @@ message Stop {
UNKNOWN = 0;
AVAILABLE = 1;
NOT_AVAILABLE = 2;
}
}

optional string stop_id = 1;
optional TranslatedString stop_code = 2;
Expand Down Expand Up @@ -1130,9 +1147,9 @@ message TripModifications {

// The following extension IDs are reserved for private use by any organization.
extensions 9000 to 9999;
}
}

// A list of selected trips affected by this TripModifications.
// A list of selected trips affected by this TripModifications.
repeated SelectedTrips selected_trips = 1;

// A list of start times in the real-time trip descriptor for the trip_id defined in trip_ids.
Expand All @@ -1144,7 +1161,7 @@ message TripModifications {
repeated string service_dates = 3;

// A list of modifications to apply to the affected trips.
repeated Modification modifications = 4;
repeated Modification modifications = 4;

// The extensions namespace allows 3rd-party developers to extend the
// GTFS Realtime Specification in order to add and evaluate new features and
Expand All @@ -1157,7 +1174,7 @@ message TripModifications {

// NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.
// Select a stop by stop sequence or by stop_id. At least one of the two values must be provided.
message StopSelector {
message StopSelector {
// Must be the same as in stop_times.txt in the corresponding GTFS feed.
optional uint32 stop_sequence = 1;
// Must be the same as in stops.txt in the corresponding GTFS feed.
Expand Down
51 changes: 34 additions & 17 deletions docs/ja/documentation/realtime/proto.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ message TripUpdate {
// In order to provide departure_occupancy_status without either arrival or
// departure StopTimeEvents, ScheduleRelationship should be set to NO_DATA.
optional VehiclePosition.OccupancyStatus departure_occupancy_status = 7;
// The relation between the StopTimeEvents and the static schedule.
enum ScheduleRelationship {
// The vehicle is proceeding in accordance with its static schedule of
Expand Down Expand Up @@ -257,7 +257,7 @@ message TripUpdate {
UNSCHEDULED = 3;
}
optional ScheduleRelationship schedule_relationship = 5
[default = SCHEDULED];
[default = SCHEDULED];
// Provides the updated values for the stop time.
// NOTE: This message is still experimental, and subject to change. It may be formally adopted in the future.
Expand Down Expand Up @@ -646,29 +646,29 @@ message Alert {
// Severity of this alert.
enum SeverityLevel {
UNKNOWN_SEVERITY = 1;
INFO = 2;
WARNING = 3;
SEVERE = 4;
UNKNOWN_SEVERITY = 1;
INFO = 2;
WARNING = 3;
SEVERE = 4;
}
optional SeverityLevel severity_level = 14 [default = UNKNOWN_SEVERITY];
// TranslatedImage to be displayed along the alert text. Used to explain visually the alert effect of a detour, station closure, etc. The image must enhance the understanding of the alert. Any essential information communicated within the image must also be contained in the alert text.
// The following types of images are discouraged : image containing mainly text, marketing or branded images that add no additional information.
// NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.
optional TranslatedImage image = 15;
optional TranslatedImage image = 15;
// Text describing the appearance of the linked image in the `image` field (e.g., in case the image can't be displayed
// or the user can't see the image for accessibility reasons). See the HTML spec for alt image text - https://html.spec.whatwg.org/#alt.
// NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.
optional TranslatedString image_alternative_text = 16;
// Description of the cause of the alert that allows for agency-specific language; more specific than the Cause. If cause_detail is included, then Cause must also be included.
// NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.
optional TranslatedString cause_detail = 17;
// Description of the effect of the alert that allows for agency-specific language; more specific than the Effect. If effect_detail is included, then Effect must also be included.
// NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.
optional TranslatedString effect_detail = 18;
Expand Down Expand Up @@ -815,7 +815,7 @@ message TripDescriptor {
CANCELED = 3;
// Should not be used - for backwards-compatibility only.
REPLACEMENT = 5 [deprecated=true];
REPLACEMENT = 5 [deprecated = true];
// An extra trip that was added in addition to a running schedule, for example, to replace a broken vehicle or to
// respond to sudden passenger load. Used with TripUpdate.TripProperties.trip_id, TripUpdate.TripProperties.start_date,
Expand Down Expand Up @@ -853,7 +853,24 @@ message TripDescriptor {
// The trip_id from the GTFS feed that is modified by the modifications_id
optional string affected_trip_id = 2;
// The initially scheduled start time of this trip instance, applied to the frequency based modified trip. Same definition as start_time in TripDescriptor.
optional string start_time = 3;
// The start date of this trip instance in YYYYMMDD format, applied to the modified trip. Same definition as start_date in TripDescriptor.
optional string start_date = 4;
// The extensions namespace allows 3rd-party developers to extend the
// GTFS Realtime Specification in order to add and evaluate new features and
// modifications to the spec.
extensions 1000 to 1999;
// The following extension IDs are reserved for private use by any organization.
extensions 9000 to 9999;
}
// Linkage to any modifications done to this trip (shape changes, removal or addition of stops).
// If this field is provided, the `trip_id`, `route_id`, `direction_id`, `start_time`, `start_date` fields of the `TripDescriptor` MUST be left empty, to avoid confusion by consumers that aren't looking for the `ModifiedTripSelector` value.
optional ModifiedTripSelector modified_trip = 7;
// The extensions namespace allows 3rd-party developers to extend the
Expand Down Expand Up @@ -1033,7 +1050,7 @@ message Shape {
// See https://developers.google.com/protocol-buffers/docs/proto#specifying_field_rules
// NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.
optional string shape_id = 1;
// Encoded polyline representation of the shape. This polyline must contain at least two points.
// For more information about encoded polylines, see https://developers.google.com/maps/documentation/utilities/polylinealgorithm
// This field is required as per reference.md, but needs to be specified here optional because "Required is Forever"
Expand All @@ -1057,7 +1074,7 @@ message Stop {
UNKNOWN = 0;
AVAILABLE = 1;
NOT_AVAILABLE = 2;
}
}
optional string stop_id = 1;
optional TranslatedString stop_code = 2;
Expand Down Expand Up @@ -1135,9 +1152,9 @@ message TripModifications {
// The following extension IDs are reserved for private use by any organization.
extensions 9000 to 9999;
}
}
// A list of selected trips affected by this TripModifications.
// A list of selected trips affected by this TripModifications.
repeated SelectedTrips selected_trips = 1;
// A list of start times in the real-time trip descriptor for the trip_id defined in trip_ids.
Expand All @@ -1149,7 +1166,7 @@ message TripModifications {
repeated string service_dates = 3;
// A list of modifications to apply to the affected trips.
repeated Modification modifications = 4;
repeated Modification modifications = 4;
// The extensions namespace allows 3rd-party developers to extend the
// GTFS Realtime Specification in order to add and evaluate new features and
Expand All @@ -1162,7 +1179,7 @@ message TripModifications {
// NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.
// Select a stop by stop sequence or by stop_id. At least one of the two values must be provided.
message StopSelector {
message StopSelector {
// Must be the same as in stop_times.txt in the corresponding GTFS feed.
optional uint32 stop_sequence = 1;
// Must be the same as in stops.txt in the corresponding GTFS feed.
Expand Down
Loading

0 comments on commit 8593c3d

Please sign in to comment.