Skip to content

Add color options to Policy in the Curbs API #195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
schnuerle merged 3 commits into from
Aug 22, 2025
Merged

Add color options to Policy in the Curbs API #195

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
63d8b4e
Added Policy Color to Curbs
schnuerle Aug 8, 2025
d74b806
Updated primary_color hex description
schnuerle Aug 8, 2025
7c2dca8
Fixed color typo
schnuerle Aug 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion curbs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ There are four different endpoints that are part of the Curbs API:
- [Rate](#rate)
- [Location Reference](#location-reference)
- [Previous Policy](#previous-policy)
- [Policy Color](#policy-color)
- [Examples](#examples)
- [Schema](#schema)

Expand Down Expand Up @@ -490,9 +491,9 @@ A Policy is represented as a JSON object whose fields are as follows:
| `rules` | Array of [Rules](#rule) | Required | The rule(s) that this policy applies. If a Policy specifies multiple rules, each rule MUST specify disjoint lists of user classes. |
| `time_spans` | Array of [Time Spans](#time-span) | Optional | If specified, this regulation only applies at the times defined within. |
| `data_source_operator_id` | Array of [UUIDs][uuid] | Optional | An array of Data Source Operator IDs that this policy only applies to. IDs come from [data_source_operators.csv](/data_source_operators.csv) file here in the CDS repo. Read our [How to Get a Data Source Operator ID](https://github.com/openmobilityfoundation/curb-data-specification/wiki/Adding-a-CDS-Data-Source-Operator-ID) guide. |
| `policy_color` | [Policy Color](#policy-color) | Optional | A JSON object that defines the official colors used to represent this specific policy, used in physical curb paint, digital and print maps, etc. |
| `external_references` | Array of [External Reference][external-reference] objects | Optional | One or more references to external data sources impacting this Curb Policy. References external sources that are relevant to this Policy at the time of its creation. More specific and timely external references can be made in related Zones, Spaces, and Areas. This field can be changed without requiring a new `curb_policy_id`, as it does not impact the policy definitions. |


[Top][toc]

### Rule
Expand Down Expand Up @@ -676,6 +677,23 @@ A Previous Policy is a JSON object with the following fields:

[Top][toc]

## Policy Color

Information about colors that apply to a specific [Policy](#policy), which in turn connects to a physical or digital [curb zone](#curb-zone). Colors reflect the physical paint color at the curb zone. Displaying visually on a map or other location may or may not align with the physical colors, per the needs of the agency. Colors are defined with RGB hex values, and should approximate real-world paint or print as closely as possible, but may not capture the entire color gamut.

A Policy Color is a JSON object with the following fields:

| Name | Type | Required/Optional | Description |
| ------------------------ | ---- | ------------------- | ------------- |
| `primary_color` | Hex | Required | The **6 digit hexidecimal triplet value** of the primary curb color, in standard capitalized RRGGBB format, without a leading hash symbol ("#"). E.g. "839D8F", "FF00FF". |
| `primary_pattern_type` | Enum | Optional | One of `solid`, `long_dash`, `short_dash`, `dot`, `dot_dash` to define the type of pattern on the `primary_color`. |
| `primary_border_color` | Hex | Optional | The 6 digit hex value of the `primary_color` border color. |
| `primary_border_pattern_type` | Enum | Optional | One of `solid`, `long_dash`, `short_dash`, `dot`, `dot_dash` to define the type of pattern on the `primary_border_color`. |
| `secondary_color` | Hex | Optional | The 6 digit hex value of the secondary curb color. |
| `secondary_border_color` | Hex | Optional | The 6 digit hex value of the `secondary_color` border color. |

[Top][toc]

# Examples

See a series of [CDS Curbs endpoint examples](examples.md) to use as templates.
Expand Down