Skip to content

Commit 0aacbbe

Browse files
committed
added beta feature designation and description
1 parent 3e246c5 commit 0aacbbe

2 files changed

Lines changed: 13 additions & 5 deletions

File tree

general-information.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ This document contains specifications that are shared between the various MDS AP
55
## Table of Contents
66

77
* [Versioning](#versioning)
8+
* [Beta Features](#betafeatures)
89

910
## Versioning
1011

@@ -45,4 +46,11 @@ Content-Type: application/vnd.mds.provider+json;version=0.3
4546

4647
The client can use the returned value verbatim as a version request in the `Accept` header.
4748

49+
## Beta Features
50+
In some cases, features within MDS may be marked as "BETA." These are typically newly established endpoints or fields. Because beta features are new, they may not 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 also likely new as well and are more likely to contain bugs or other problems. Beta features are likely to evolve more rapidly than other parts of the specification.
51+
52+
Despite this, MDS users are encouraged to use beta features. New features can only become proven and trusted through use and the learning that comes with it. Users should be thoughtful about the role of beta features in their operations. Beta features are suitable for enabling new tools and analysis, but may not be appropriate for mission-critical regulatory decisions where certainty and reliability are essential.
53+
54+
Users of beta features are strongly encouraged to share their experiences, learnings, and challenges with the broader MDS community via GitHub issues or pull requests. This will help the community make the improvements that allow beta features to become proven, stable parts of the specification.
55+
4856
[Top](#table-of-contents)

provider/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ Unless stated otherwise by the municipality, the trips endpoint must return all
203203

204204
**Endpoint:** `/trips`
205205
**Method:** `GET`
206-
**Required/Optional:** Required
206+
**[Beta feature](/general-information.md#beta-features):** No
207207
**Schema:** [`trips` schema][trips-schema]
208208
**`data` Payload:** `{ "trips": [] }`, an array of objects with the following structure
209209

@@ -294,7 +294,7 @@ Unless stated otherwise by the municipality, this endpoint must return only thos
294294
295295
**Endpoint:** `/status_changes`
296296
**Method:** `GET`
297-
**Required/Optional:** Required
297+
**[Beta feature](/general-information.md#beta-features):** No
298298
**Schema:** [`status_changes` schema][sc-schema]
299299
**`data` Payload:** `{ "status_changes": [] }`, an array of objects with the following structure
300300

@@ -375,7 +375,7 @@ The schema and datatypes are the same as those defined for [`/status_changes`][s
375375

376376
**Endpoint:** `/events`
377377
**Method:** `GET`
378-
**Required/Optional:** Optional starting with `0.4.0`, moving to Required in a future version (`0.5.0`+)
378+
**[Beta feature](/general-information.md#beta-features):** Yes (as of 0.4.0)
379379
**Schema:** [`events` schema][events-schema]
380380
**`data` Payload:** `{ "status_changes": [] }`, an array of objects with the same structure as in [`/status_changes`][status]
381381

@@ -422,7 +422,7 @@ ttl | Yes | Integer representing the number of millisecond
422422

423423
**Endpoint:** `/vehicles`
424424
**Method:** `GET`
425-
**Required/Optional:** Optional starting with `0.4.1`, moving to Required in a future version (`0.5.0`+)
425+
**[Beta feature](/general-information.md#beta-features):** Yes (as of 0.4.1)
426426
**Schema:** [`vehicles` schema][vehicles-schema]
427427
**`data` Payload:** `{ "vehicles": [] }`, an array of objects with the following structure
428428

@@ -451,4 +451,4 @@ ttl | Yes | Integer representing the number of millisecond
451451
[toc]: #table-of-contents
452452
[trips-schema]: dockless/trips.json
453453
[ts]: #timestamps
454-
[vehicles-schema]: dockless/vehicles.json
454+
[vehicles-schema]: dockless/vehicles.json

0 commit comments

Comments
 (0)