Skip to content

Commit a95cfe9

Browse files
authored
Removing Geography from Policy
1 parent 0a23642 commit a95cfe9

1 file changed

Lines changed: 7 additions & 28 deletions

File tree

policy/README.md

Lines changed: 7 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -149,20 +149,7 @@ Policies will be returned in order of effective date (see schema below), with pa
149149

150150
### Geographies
151151

152-
**Deprecated:** see the new [Geography API](/geography#transition-from-policy) to understand the transition away from this endpoint, and how to support both in MDS 1.x.0 releases.
153-
154-
**Endpoint**: `/geographies/{id}`
155-
**Method**: `GET`
156-
**Schema:** [`policy` schema][json-schema]
157-
**`data` Payload**: `{ geographies: [] }`, an array of GeoJSON `Feature` objects that follow the schema [outlined here](#geography) or in [Geography](/geography#general-information).
158-
159-
#### Query Parameters
160-
161-
| Name | Type | Required / Optional | Description |
162-
| ------------ | --------- | --- | ---------------------------------------------- |
163-
| `id` | UUID | Optional | If provided, returns one [Geography](/geography#general-information) object with the matching UUID; default is to return all geography objects. |
164-
165-
[Top][toc]
152+
**Deprecated:** see the [Geography API](/geography#transition-from-policy) for the current home of this endpoint.
166153

167154
### Requirements
168155

@@ -180,12 +167,12 @@ See [Policy Requirements Examples](/policy/examples/requirements.md) for how thi
180167

181168
To use flat files, policies shall be represented in two (2) files:
182169

183-
- `policies.json`
184-
- `geographies.json`
170+
- `policies.json` in Policy API
171+
- `geographies.json` in Geography API
185172

186173
The files shall be structured like the output of the [REST endpoints](#rest-endpoints) above.
187174

188-
The publishing Agency should establish and communicate to providers how frequently these files should be polled.
175+
The publishing agency should establish and communicate to providers how frequently these files should be polled.
189176

190177
The `updated` field in the payload wrapper should be set to the time of publishing a revision, so that it is simple to identify a changed file.
191178

@@ -335,26 +322,18 @@ An individual `Rule` object is defined by the following fields:
335322

336323
### Geography
337324

338-
**Deprecated:** see the new [Geography API](/geography#transition-from-policy) to understand the transition away from this endpoint, and how to support both in a MDS 1.x.0 release.
339-
340-
| Name | Type | Required / Optional | Description |
341-
| ---------------- | --------- | --- | ----------------------------------------------------------------------------------- |
342-
| `name` | String | Required | Name of geography |
343-
| `description` | String | Optional | Detailed description of geography |
344-
| `geography_id` | UUID | Required | Unique ID of [Geography](/geography#general-information) |
345-
| `geography_json` | JSON | Required | The GeoJSON that defines the geographical coordinates.
346-
| `effective_date` | [timestamp][ts] | Optional | `start_date` for first published policy that uses this geo. Server should set this when policies are published. This may be used on the client to distinguish between “logical” geographies that have the same name. E.g. if a policy publishes a geography on 5/1/2020, and then another policy is published which references that same geography is published on 4/1/2020, the effective_date will be set to 4/1/2020.
347-
| `published_date` | [timestamp][ts] | Required | Timestamp that the policy was published, i.e. made immutable |
348-
| `prev_geographies` | UUID[] | Optional | Unique IDs of prior [geographies](/geography#general-information) replaced by this one |
325+
**Deprecated:** see the [Geography API](/geography#transition-from-policy) for the current home of this endpoint.
349326

350327
[Top][toc]
351328

352329
### Rates
330+
353331
Rate-related properties can currently be specified on all rule types except `user`, i.e. any rule that can be measured.
354332

355333
**[Beta feature](/general-information.md#beta-features)**: *No (as of 2.0.0)*. [Leave feedback](https://github.com/openmobilityfoundation/mobility-data-specification/issues/674)
356334

357335
#### Rate Amounts
336+
358337
The amount of a rate applied when this rule applies, if applicable (default zero). A positive integer rate amount represents a fee, while a negative integer represents a subsidy. Rate amounts are given in the `currency` defined in the [Policy](#policy).
359338

360339
#### Rate Recurrences

0 commit comments

Comments
 (0)