Skip to content

Commit 01ae6d2

Browse files
authored
Added Version Tracking section to Reqs
1 parent abccb73 commit 01ae6d2

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

policy/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ This specification describes the digital relationship between _mobility as a ser
3131
- [Requirement](#requirement)
3232
- [Update Frequency](#requirement-update-frequency)
3333
- [Public Hosting](#public-hosting)
34+
- [Version Tracking](#version-tracking)
3435
- [Beta Limitations](#beta-limitations)
3536
- [Format](#requirement-format)
3637
- [Metadata](#requirement-metadata)
@@ -430,6 +431,12 @@ This endpoint is not authenticated (ie. public), and allows the discovery of oth
430431

431432
The OMF recommends updating the Requirements feed no more than monthly, and you may specify your expected timeframe with the `max_update_interval` in the [metadata](#requirement-metadata) section so providers have some idea of how often to check the feed. More specifically the OMF recommends giving the following notice to providers: 1 month for optional field additions, 3 months for endpoint/API changes/additions, 3 months for new minor releases, and 4 months for major releases. You should also communicate these future changes ahead of time with the `start_date` field. Finally, the OMF recommends any changes need to be part of a discussion between agencies and affected providers.
432433

434+
#### Version Tracking
435+
436+
If you are upgrading to a new MDS version, it is recommended to create a new requirements file at a new URL, since field names and available options may have changed. To make this more obvious, the MDS version number could be part of your URL, e.g. "https://mds.cityname.gov/requirements/**1.2.0**".
437+
438+
When requirements are updated within the same MDS version, in the [metadata](#requirement-metadata) section, increment the `file_version` value by one and update the `last_updated` timestamp. Though not required, you may choose to use the `start_date` and `end_date` fields to keep retired requirements visible. We also recommend hosting your requirements file in a location that has a publicly-accessible version history, like GitHub or Bitbucket, or keeping previous versions accessible with a versioned URL, e.g. "https://mds.cityname.gov/requirements/1.2.0/**v3**".
439+
433440
#### Beta Limitations
434441

435442
Note that while Requirements is in [beta](#Requirements) in this **minor**, non-breaking MDS 1.2.0 release, items listed as "required" or "disallowed" will be treated as a _request_ only by default (precluding intentional formal agency communications with providers) to prevent an _unintentional_ burden on providers. For the next **major**, breaking MDS 2.0.0 release, these items will be required or disallowed as documented.

0 commit comments

Comments
 (0)