Skip to content

Policy Requirements OMF Hosting Guidance

Michael Schnuerle edited this page Feb 11, 2022 · 5 revisions

Policy Requirements - OMF Hosting Guidance

MDS Policy Icon

An agency's program Policy Requirements endpoint enumerates all of the parts of MDS, GBFS, and other specifications that an agency requires from providers for certain programs, including APIs, endpoints, and optional fields, as well as information for providers about the APIs the agency is hosting within Geography, Policy, and Jurisdiction. It is not authenticated (ie. public), and the requirements file can be referenced directly in an agency's operating permit/policy document when discussing program data requirements, and updated digitally as needed.

The agency can host this as a file on their servers, on a third party server, or the OMF can host on behalf of an agency in the agency program requirements repo. This "Requirements OMF Hosting Guidance" document provides more information on how to do this.

OMF Hosting

If an agency cannot or does not want to host their own Requirements file, there is an option for city/governmental agencies to freely store and link to their MDS program Policy Requirements file, hosted by the OMF on GitHub.

Adding Your File

Additions and updates to files can be made by opening an issue, creating a PR, or contacting the OMF. Changes to the file are automatically tracked. OMF Staff is responsible for final approvals and ensures the files are valid.

File Creation

The first step is to create your file per the Requirements spec, in JSON format. You can do this in a text editor, programming application, online, or on GitHub. We have created some examples to get you started.

Clone this wiki locally