Skip to content

Commit 3d1c0e4

Browse files
authored
Clarifying authentication for 3 APIs
1 parent 2c0a3fd commit 3d1c0e4

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

general-information.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ This document contains specifications that are shared between the various MDS [A
44

55
## Table of Contents
66

7+
- [Authentication](#authentication)
78
- [Beta Features](#beta-features)
89
- [Costs and Currencies](#costs-and-currencies)
910
- [Data Types](#data-types)
@@ -14,14 +15,21 @@ This document contains specifications that are shared between the various MDS [A
1415
- [Stop-based Geographic Data](#stop-based-geographic-data)
1516
- [Intersection Operation](#intersection-operation)
1617
- [Geography-Driven Events](#geography-driven-events)
17-
- [Optional Authentication](#optional-authentication)
1818
- [Responses](#responses)
1919
- [Error Messages](#error-messages)
2020
- [Strings](#strings)
2121
- [Timestamps](#timestamps)
2222
- [UUIDs](#uuids)
2323
- [Versioning](#versioning)
2424

25+
## Authentication
26+
27+
If implementing MDS Policy, Geography, and/or Jurisdiction APIs and endpoints, an agency must make them unauthenticated and public. This allows transparency for the public to see how the city is regulating, holds the city accountable for their policy decisions, and reduces the technical burden on providers to use these endpoints. A side benefit is that this allows third parties to ingest this information into their applications and services for public benefit.
28+
29+
All other MDS APIs require authentication, as outlined.
30+
31+
[Top][toc]
32+
2533
## Beta Features
2634

2735
In some cases, features within MDS may be marked as "beta." These are typically recently added endpoints or fields. Because beta features are new, they may not yet be fully mature and proven in real-world operation. The design of beta features may have undiscovered gaps, ambiguities, or inconsistencies. Implementations of those features are typically also quite new and are more likely to contain bugs or other flaws. Beta features are likely to evolve more rapidly than other parts of the specification.
@@ -110,14 +118,6 @@ During the Beta period for this feature, location and telemetry data remain requ
110118

111119
[Top][toc]
112120

113-
## Optional Authentication
114-
115-
Authorization of the Policy and Geography APIs is no longer required and will be deprecated in next major release with these endpoints (plus Jurisdictions) becoming 'optionally private' instead of 'optionally public'. An agency may optionally decide to make the Policy and Geography endpoints, as well as Jurisdictions, unauthenticated and public. This allows transparency for the public to see how the city is regulating, holds the city accountable for their policy decisions, and reduces the technical burden on providers to use these endpoints. A side benefit is that this allows third parties to ingest this information into their applications and services for public benefit.
116-
117-
Note if implementing the beta feature [Geography Driven Events](/general-information.md#geography-driven-events), both Policy and Geography must be public.
118-
119-
[Top][toc]
120-
121121
## Responses
122122

123123
* **200:** OK: operation successful.

0 commit comments

Comments
 (0)