Skip to content

Commit 8c52d4d

Browse files
Merge remote-tracking branch 'upstream/dev' into dev
2 parents 9ecff7c + 5a805be commit 8c52d4d

11 files changed

Lines changed: 158 additions & 68 deletions

File tree

.github/ISSUE_TEMPLATE/release-candidate-review.md

Lines changed: 0 additions & 18 deletions
This file was deleted.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
name: Default
3+
about: Suggest changes to MDS
4+
title: <Insert Title>
5+
6+
---
7+
18
# MDS Pull Request
29

310
Thank you for your contribution!
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Release Candidate
3+
about: Initiate discussion to obtain OMF approval for new release
4+
title: Release Candidate [X.Y.Z]
5+
labels: admin
6+
assignees: jfh01
7+
8+
---
9+
10+
### Summary
11+
12+
The Release Candidate for MDS `X.Y.Z` has been submitted: <https://github.com/openmobilityfoundation/mobility-data-specification/releases/tag/X.Y.Z-rc>
13+
14+
Please use this pull request to track Technology Council and OMF Board feedback and/or requested changes.
15+
16+
### Action Item
17+
18+
This pull request will be merged by an OMF maintainer after OMF Board Approval following the [Release Guidelines](https://github.com/openmobilityfoundation/mobility-data-specification/blob/master/ReleaseGuidelines.md#making-a-release).
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Release Final
3+
about: Finalize and publish an OMF approved release
4+
title: Release [X.Y.Z]
5+
labels: admin
6+
assignees: jfh01
7+
8+
---
9+
10+
### Summary
11+
12+
The Release Candidate for MDS `X.Y.Z` has been approved: <https://github.com/openmobilityfoundation/mobility-data-specification/releases/tag/X.Y.Z-rc>
13+
14+
This pull request will make the release official in `master`.
15+
16+
### Action Item
17+
18+
Merge this pull request following the [Release Guidelines](https://github.com/openmobilityfoundation/mobility-data-specification/blob/master/ReleaseGuidelines.md#making-a-release).

ReleaseGuidelines.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Contributors submit proposals for inclusion in the release cycle in the form of
9797

9898
Contributors will provide feedback on proposals. Where possible, discussion will happen via GitHub. Weekly calls will support dialog around more complex or controversial issues. By the end of week 9, all active proposals must be in the form of a pull request. Proposals can be withdrawn or split apart for inclusion in future releases.
9999

100-
##### Weeks 10-11: Decision making
100+
#### Weeks 10-11: Decision making
101101

102102
These weeks will start with an web conference work session for all contributors to review and discuss current proposals. Goal is to achieve consensus where possible, or to clearly articulate areas of disagreement where not. Minor changes may be accepted at this stage if they bring contributors to consensus.
103103

@@ -228,7 +228,7 @@ The following steps outline the process to prepare a Release Candidate of MDS. T
228228
This is a pre-release: Check
229229
```
230230
231-
1. [Open an Issue][mds-issue-new] to start the Release Candidate review process, using the `Release Candidate review` template. Fill in the appropriate Release Candidate version/URL.
231+
1. [Open a Pull Request][mds-pr-rc] from the release branch to `dev`. This ensures any changes to the Release Candidate during the review process make their way back into `dev`. This pull request is where review comments and feedback will be collected.
232232
233233
1. Post an announcement to the [MDS-announce Mailing List][mds-announce], copying the [release notes](ReleaseNotes.md) created earlier and linking to the [GitHub release][mds-releases] and Release Candidate review Issue:
234234
@@ -270,7 +270,9 @@ Repeat as-needed for subsequent Release Candidates.
270270
271271
The following steps describe how to make an approved [Release Candidate][prepare-rc] an official release of MDS:
272272
273-
1. Ensure OMF review has been completed and the Issue created during the Release Candidate process has been closed.
273+
1. Ensure OMF review has been completed and approval granted.
274+
275+
1. Ensure the [Milestone][mds-milestones] for this release is at `100%`.
274276
275277
1. In the release branch created earlier, update the ReleaseNotes.md with the new date of the release:
276278
@@ -283,9 +285,9 @@ The following steps describe how to make an approved [Release Candidate][prepare
283285
etc...
284286
```
285287
286-
1. [Open a Pull Request][mds-pr-new] from the release branch to `dev`. This ensures any changes to the Release Candidate during the review process make their way back into `dev`. Merge this PR.
288+
1. Merge the Pull Request created during the Release Candidate process to `dev`.
287289
288-
1. [Open a Pull Request][mds-pr-new] from the release branch to `master`. Merge this PR to make the release official.
290+
1. [Open a Pull Request][mds-pr-final] from the release branch to `master`. Merge this PR to make the release official.
289291
290292
1. Create a tag in `master` for the new version. For example for `0.5.0`:
291293
@@ -372,6 +374,8 @@ In rare cases, a hotfix for a prior release may be required out-of-phase with th
372374
[mds-milestones]: https://github.com/openmobilityfoundation/mobility-data-specification/milestones
373375
[mds-pr]: https://github.com/openmobilityfoundation/mobility-data-specification/pulls
374376
[mds-pr-new]: https://github.com/openmobilityfoundation/mobility-data-specification/compare
377+
[mds-pr-rc]: https://github.com/openmobilityfoundation/mobility-data-specification/compare?template=release-candidate.md
378+
[mds-pr-final]: https://github.com/openmobilityfoundation/mobility-data-specification/compare?template=release-final.md
375379
[mds-releases]: https://github.com/openmobilityfoundation/mobility-data-specification/releases
376380
[mds-releases-new]: https://github.com/openmobilityfoundation/mobility-data-specification/releases/new
377381
[mds-schema-common]: https://github.com/openmobilityfoundation/mobility-data-specification/blob/master/schema/templates/common.json

ReleaseNotes.md

Lines changed: 85 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,53 @@
1-
## 0.4.0
1+
## 0.4.1
2+
3+
> Released 2020-05-15
4+
5+
0.4.1 is the first release of the Mobility Data Specification under the guidance and stewardship of the Open Mobility Foundation.
6+
As such, this release includes a number of administrative and documentation changes, including to the licensing and release process.
7+
This release also brings a number of language clarifications from 0.4.0 and new features across the various APIs, including the much anticipated /vehicles endpoint in Provider.
8+
9+
### CHANGES
10+
11+
*_MDS_*
12+
13+
* [MDS officially transferred from LADOT to OMF](https://github.com/openmobilityfoundation/mobility-data-specification/issues/386):
14+
* [Update license from CC0 to CC-BY](https://github.com/openmobilityfoundation/mobility-data-specification/pull/390)
15+
* [Updates to various documentation to support code transfer from LADOT to OMF](https://github.com/openmobilityfoundation/mobility-data-specification/pull/391)
16+
* [Switch CODEOWNERS to use OMF teams](https://github.com/openmobilityfoundation/mobility-data-specification/pull/404)
17+
* [Add documentation around currently Supported MDS versions](https://github.com/openmobilityfoundation/mobility-data-specification/pull/449)
18+
* [Add documentation around Understanding MDS APIs](https://github.com/openmobilityfoundation/mobility-data-specification/pull/452)
19+
* [ReleaseGuidelines updates to reflect OMF process and 12 week dev cycle](https://github.com/openmobilityfoundation/mobility-data-specification/pull/453)
20+
* [Added "moped" vehicle type](https://github.com/openmobilityfoundation/mobility-data-specification/pull/416)
21+
22+
*_Provider_*
23+
24+
* [Mention ambiguity for event_type reserved](https://github.com/openmobilityfoundation/mobility-data-specification/pull/439)
25+
* [Clarify no pagination on /trips and /status_changes](https://github.com/openmobilityfoundation/mobility-data-specification/pull/424)
26+
* [Make required/optional endpoints more explicit](https://github.com/openmobilityfoundation/mobility-data-specification/pull/456)
27+
* [Adding a /vehicles endpoint](https://github.com/openmobilityfoundation/mobility-data-specification/pull/376)
28+
* [JSON Schema fixes/updates](https://github.com/openmobilityfoundation/mobility-data-specification/pull/458)
29+
30+
*_Agency_*
31+
32+
* [Add decommissioned event type reason](https://github.com/openmobilityfoundation/mobility-data-specification/pull/408)
33+
* [Add versioning](https://github.com/openmobilityfoundation/mobility-data-specification/pull/444)
34+
35+
*_Policy_*
36+
37+
* [Update documentation to use correct field name](https://github.com/openmobilityfoundation/mobility-data-specification/pull/412)
38+
* [Add missing rule_id](https://github.com/openmobilityfoundation/mobility-data-specification/pull/409)
39+
* [Add versioning](https://github.com/openmobilityfoundation/mobility-data-specification/pull/444)
40+
41+
## 0.4.0
242

343
> Release 2019-10-31
444
5-
The 0.4.0 release represents a major step forward in the Mobility Data Specification. The `provider` endpoints have been refactored to allow static file backed API servers which should improve uptime, reliability and the ability to backfill what is now growing to years of data. There is a new `policy` API endpoint, designed to be implemented by Agencies, that allows for clearer communication of geofencing, vehicle caps and more. A full list of changes is below. Many thanks to all the contributors who helped on this release.
45+
The 0.4.0 release represents a major step forward in the Mobility Data Specification. The `provider` endpoints have been refactored to allow static file backed API servers which should improve uptime, reliability and the ability to backfill what is now growing to years of data. There is a new `policy` API endpoint, designed to be implemented by Agencies, that allows for clearer communication of geofencing, vehicle caps and more. A full list of changes is below. Many thanks to all the contributors who helped on this release.
46+
47+
### CHANGES
648

7-
**CHANGES**
849
*_Provider_*
50+
951
* [Improved Handling of Cost Data](https://github.com/openmobilityfoundation/mobility-data-specification/pull/388)
1052
* [Allow static file storage backed API Endpoints](https://github.com/openmobilityfoundation/mobility-data-specification/pull/357)
1153
* [Cleanup Provider README](https://github.com/openmobilityfoundation/mobility-data-specification/pull/395)
@@ -16,99 +58,107 @@ The 0.4.0 release represents a major step forward in the Mobility Data Specifica
1658
* [Update Status Change JSON Schema to include Associated Trip properly](https://github.com/openmobilityfoundation/mobility-data-specification/pull/353)
1759

1860
*_Agency_*
61+
1962
* [Add Accuracy Field for GPS Telemetry Data](https://github.com/openmobilityfoundation/mobility-data-specification/pull/360)
2063
* [String Limit to 255 Characters](https://github.com/openmobilityfoundation/mobility-data-specification/pull/361)
2164
* [Remove SLA from /telemetry](https://github.com/openmobilityfoundation/mobility-data-specification/pull/371)
2265
* [Update State Machine Diagram](https://github.com/openmobilityfoundation/mobility-data-specification/pull/363)
2366

24-
*_Misc_*
67+
*_Misc_*
68+
2569
* [New Policy API Endpoint](https://github.com/openmobilityfoundation/mobility-data-specification/pull/382)
2670
* [Improved README for Schema Directory](https://github.com/openmobilityfoundation/mobility-data-specification/pull/398)
2771
* [Add Car Vehicle Type](https://github.com/openmobilityfoundation/mobility-data-specification/pull/219)
2872
* [Unify Error Responses between Provider / Agency](https://github.com/openmobilityfoundation/mobility-data-specification/pull/368)
2973
* [Improvements to Release Process](https://github.com/openmobilityfoundation/mobility-data-specification/pull/372)
3074

31-
## 0.3.2
75+
## 0.3.2
3276

3377
> Released 2019-06-13
3478
35-
This release is a series of non breaking and minor changes for provider, along with JSON Schema for agency.
79+
This release is a series of non breaking and minor changes for provider, along with JSON Schema for agency.
3680

37-
**CHANGES**
81+
### CHANGES
3882

3983
*_Provider_*
84+
4085
* [Add an optional recorded field to provider](https://github.com/openmobilityfoundation/mobility-data-specification/issues/307)
4186
* [Ordering Definitions](https://github.com/openmobilityfoundation/mobility-data-specification/pull/301)
4287
* [406 response - version negiotation](https://github.com/openmobilityfoundation/mobility-data-specification/pull/327)
4388

4489
*_Agency_*
45-
[JSON Schema for Agency](https://github.com/openmobilityfoundation/mobility-data-specification/issues/169)
90+
91+
* [JSON Schema for Agency](https://github.com/openmobilityfoundation/mobility-data-specification/issues/169)
4692

4793
*_Misc_*
48-
[Schema Folder Cleanup](https://github.com/openmobilityfoundation/mobility-data-specification/pull/328)
49-
[Global GNSS Support](https://github.com/openmobilityfoundation/mobility-data-specification/pull/316)
94+
95+
* [Schema Folder Cleanup](https://github.com/openmobilityfoundation/mobility-data-specification/pull/328)
96+
* [Global GNSS Support](https://github.com/openmobilityfoundation/mobility-data-specification/pull/316)
97+
5098
## 0.3.1
5199

52100
> Released 2019-04-30
53101
54-
This release represents a series of non-breaking changes and clarifications for provider, along with a number of agency bugfixes / changes.
102+
This release represents a series of non-breaking changes and clarifications for provider, along with a number of agency bugfixes / changes.
55103

56-
**CHANGES**
104+
### CHANGES
57105

58106
*_Provider_*
107+
59108
* MDS Schema version fix.
60-
* [New release process](https://github.com/openmobilityfoundation/mobility-data-specification/pull/264). Thanks @jfh for documenting, all for participating
109+
* [New release process](https://github.com/openmobilityfoundation/mobility-data-specification/pull/264). Thanks @jfh for documenting, all for participating
61110
* [Additional documentation around what is considered Breaking / Non-Breaking](https://github.com/openmobilityfoundation/mobility-data-specification/pull/295). Thanks @rf-
62111
* [OPTIONS for version negotiation](https://github.com/openmobilityfoundation/mobility-data-specification/pull/293). Thanks @billdirks
63-
* [Add Agency Drop off / pick up](https://github.com/openmobilityfoundation/mobility-data-specification/pull/291). Thanks @margodawes
112+
* [Add Agency Drop off / pick up](https://github.com/openmobilityfoundation/mobility-data-specification/pull/291). Thanks @margodawes
64113
* [Explicitly allow associated_trip for any event type](https://github.com/openmobilityfoundation/mobility-data-specification/pull/297)
65114

66115
*_Agency_*
116+
67117
* Change from UUIDv4 to just UUID. Thanks @karcass
68-
* Change Error Messages for State Machine validation.
69-
* Update Pagination Rules
70-
* Add Unregistered event.
118+
* Change Error Messages for State Machine validation.
119+
* Update Pagination Rules
120+
* Add Unregistered event.
71121
* [Add Event Diagram](https://github.com/openmobilityfoundation/mobility-data-specification/pull/258). Thanks @whereissean
72122
* [Removing 412 Responses](https://github.com/openmobilityfoundation/mobility-data-specification/pull/258)
73-
* Add deregister and decomissioned events. Thanks @dirkdk
123+
* Add deregister and decomissioned events. Thanks @dirkdk
74124
* [Remove 5 second Telemetry requirement](https://github.com/openmobilityfoundation/mobility-data-specification/pull/261)
75125
* [Improve failure and error handling around Telemetry Data](https://github.com/openmobilityfoundation/mobility-data-specification/pull/290)
76126

77-
## 0.3.0
127+
## 0.3.0
78128

79129
> Released 2019-02-15
80130
81-
This release is the first minor version release of MDS with breaking changes for deployed provider API instances.
131+
This release is the first minor version release of MDS with breaking changes for deployed provider API instances.
82132

83-
**CHANGES**
133+
### CHANGES
84134

85-
* Improved Time Based Filtering Query Parameters. #139. Thanks @babldev
86-
* Changes in Service Area for Agency API.
135+
* Improved Time Based Filtering Query Parameters. #139. Thanks @babldev
136+
* Changes in Service Area for Agency API.
87137
* Switch timestamps to Integer milliseconds since Epoch rather then seconds. #179
88138
* Removed unused bbox query parameter. #183
89139
* Add GBFS discovery URL to `/providers.csv`. #205. Thanks @asadowns
90140
* Associated Trips -> Associated Trip, no longer an array. #88, #202, #217. Thanks @black-tea, @oderby
91-
* Version Requirements and documentation. #152, #216, and #114
92-
* Agency API refactors to support launch of ladot.io sandbox. #193, #194. Thanks @toddapetersen, @sebdiem, @cttengsfmta.
93-
* Clarification on Service Starts, Service Ends and Municipal Boundaries. #211, #226
94-
* Documentation on how to implement truncate to save on payload size.
141+
* Version Requirements and documentation. #152, #216, and #114
142+
* Agency API refactors to support launch of ladot.io sandbox. #193, #194. Thanks @toddapetersen, @sebdiem, @cttengsfmta.
143+
* Clarification on Service Starts, Service Ends and Municipal Boundaries. #211, #226
144+
* Documentation on how to implement truncate to save on payload size.
95145

96146
## 0.2.1
97147

98148
> Released 2018-12-03
99149
100-
This release is the first patch release of MDS 0.2.
150+
This release is the first patch release of MDS 0.2.
101151

102-
We did not chose to include the `timestamp` change, as discussed in issue #104, because it is breaking. Early versions of this branch included that change. The change will be made in MDS 0.3.0.
152+
We did not chose to include the `timestamp` change, as discussed in issue #104, because it is breaking. Early versions of this branch included that change. The change will be made in MDS 0.3.0.
103153

104-
**CHANGES**
154+
### CHANGES
105155

106-
* Release Guidelines. Ref #147 #129
107-
* Many Validator Fixes/Null Fixes. Ref #166 #165 #128
108-
* Many Clarifications / Cleanup to make the spec easier to read.
109-
* JSON Schema is now much closer to the written spec, fails on Null if required, doesn't fail if field is not required.
156+
* Release Guidelines. Ref #147 #129
157+
* Many Validator Fixes/Null Fixes. Ref #166 #165 #128
158+
* Many Clarifications / Cleanup to make the spec easier to read.
159+
* JSON Schema is now much closer to the written spec, fails on Null if required, doesn't fail if field is not required.
110160

111-
Thanks to all contributors.
161+
Thanks to all contributors.
112162

113163
## 0.1.1
114164

agency/get_vehicle.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,8 @@
182182
},
183183
"event_type_reason": {
184184
"enum": [
185-
"missing"
185+
"missing",
186+
"decommissioned"
186187
]
187188
}
188189
}

agency/post_vehicle_event.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,4 +248,4 @@
248248
}
249249
},
250250
"additionalProperties": false
251-
}
251+
}

0 commit comments

Comments
 (0)