Skip to content

Commit 6a6360d

Browse files
committed
Added use cases to requirements
1 parent fd4cdda commit 6a6360d

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

policy/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -632,7 +632,7 @@ For each combination of items in a program, you can specify the data specs, APIs
632632

633633
#### Requirement APIs
634634

635-
For each data specification, you can specify which APIs, endpoints, and fields are required from providers, and which are available from your agency.
635+
For each data specification, you can specify which APIs, endpoints, and fields are required from providers, and which are available from your agency, and the use cases you need the data for.
636636

637637
An agency may require providers to serve optional APIs, endpoints, and fields that are needed for your agency's program. This is a `required_apis` array within the [Requirement Data Specs](#requirement-data-specs) section in the [Requirement](#requirement) data feed.
638638

@@ -661,6 +661,13 @@ You may also show which APIs, endpoints, and fields your agency is serving to pr
661661
]
662662
},
663663
// other APIs in same data spec
664+
"use_cases": [
665+
{
666+
"external_url": "[REFERENCE URL]",
667+
"ids": ["1","2","3"]
668+
},
669+
// next external use case source
670+
]
664671
],
665672
"available_apis": [
666673
{
@@ -685,6 +692,7 @@ You may also show which APIs, endpoints, and fields your agency is serving to pr
685692
| -------------------- | ----- | -------- | ----------------------------------- |
686693
| `api_name` | Text | Required | Name of the applicable API required. At least one API is required. APIs not listed will not be available to the agency. E.g. for MDS: 'provider', or 'agency'. For GBFS, this field is omitted since GBFS starts at the `endpoint` level. |
687694
| `endpoint_name` | Text | Required | Name of the required endpoint under the API. At least one endpoint is required. E.g. for MDS 'provider': 'trips' |
695+
| `use_cases` | Object with Array | Optional | The list of policy uses cases that this data standard's information covers for your program. Includes an `external_url` to a HTTP reference list or database (e.g. to the [OMF Use Case Database](https://airtable.com/shrPf4QvORkjZmHIs/tblzFfU6fxQm5Sdhm)), **and** an array of `ids` of each applicable use case (e.g. "OMF-MDS-31"). You may enumerate multiple external use case sources and ids. |
688696

689697
**Provider Endpoints** - Specific to the `required_apis` array
690698

0 commit comments

Comments
 (0)