Skip to content

Commit 37fcf3a

Browse files
committed
Added use case example
1 parent 6a6360d commit 37fcf3a

2 files changed

Lines changed: 18 additions & 10 deletions

File tree

policy/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -659,15 +659,7 @@ You may also show which APIs, endpoints, and fields your agency is serving to pr
659659
},
660660
// other endpoints
661661
]
662-
},
663-
// 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-
]
662+
}
671663
],
672664
"available_apis": [
673665
{
@@ -684,6 +676,14 @@ You may also show which APIs, endpoints, and fields your agency is serving to pr
684676
// other endpoints
685677
]
686678
}
679+
],
680+
// other APIs in same data spec
681+
"use_cases": [
682+
{
683+
"external_url": "[REFERENCE URL]",
684+
"ids": ["1","2","3"]
685+
},
686+
// next external use case source
687687
]
688688
// ...
689689
```

policy/examples/requirements.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,7 @@ Version 1.1.0 for 2 providers asking for only historic [Provider `/trips`](/prov
318318

319319
## Provider and Other APIs
320320

321-
Version 1.1.0 or 0.4.1 for 3 providers with many APIs and endpoints.
321+
Version 1.1.0 or 0.4.1 for 3 providers with many APIs and endpoints, for two programs: shared dockless and city docked bikes. With use cases added.
322322

323323
Note: by specifying geography, policy, and jurisdiction here with a URL, the agency is in effect saying that they have created and are hosting these, and they are available for use if public.
324324

@@ -431,6 +431,14 @@ Note: by specifying geography, policy, and jurisdiction here with a URL, the age
431431
{
432432
"api_name": "metrics"
433433
}
434+
],
435+
"use_cases": [
436+
{
437+
"external_url": "https://airtable.com/shrPf4QvORkjZmHIs/tblzFfU6fxQm5Sdhm",
438+
"ids": ["OMF-MDS-2","OMF-MDS-8","OMF-MDS-12","OMF-MDS-13","OMF-MDS-14","OMF-MDS-20","OMF-MDS-29","OMF-MDS-31","OMF-MDS-44"]
439+
},
440+
"external_url": "https://github.com/CDSM-WG/CDS-M/tree/main/use-cases",
441+
"ids": ["open-data","most-used-routes","vehicle-cap","impact-on-transit","origins","vehicle-rotation","distribution-requirements-availability","distribution-requirements-availability","publish-speed-regulations"]
434442
]
435443
},
436444
{

0 commit comments

Comments
 (0)