Creating Curb Objects #126

jacobmalleau · 2023-11-20T01:20:16Z

Explain pull request

First commit / defining Curb Object

Is this a breaking change

No, not breaking

Impacted Spec

Which API(s) will this pull request impact?

Curbs
Events
Metrics

Additional context

Add any other context or screenshots about the feature request here.

First commit / defining Curb Object

CLAassistant · 2023-11-20T01:20:22Z

All committers have signed the CLA.

- Note centroid of object - Note positive and negative distances - Start to populate type specific attributes

Updated language around Object Type Attributes based on latest discussions. It omits details on specific attributes for future versions of the spec.

jamesian-barr · 2024-10-16T20:44:41Z

@jacobmalleau this PR appears to be in decent shape. What do we need to do to take this to review?

schnuerle · 2024-10-16T21:07:27Z

@jamesian-barr there's probably a few more things to finish and revise on here. I'll make some targeted comments.

Then the steering committee (SC) can bring it before the working group for review. There is a SC meeting next week so we can see if this is ready to present.

And I think we need to finalize all the 1.0.1 issues and PRs (7 open, 10 done) and merge to 'dev' first so we don't run into any conflicts. So feel free to review and comment on those.

schnuerle · 2024-10-16T21:09:03Z

curbs/README.md

+
+Some object types will have unique, custom attributes that can be optionally included with the given object type. These are given as unordered key-value pairs, e.g. `kilowatts` :  `1.21`. For this current version of Curb Objects, specific object type attributes will not be included in the specification. As use of Curb Objects grows or specific use cases become more involved, common object type attributes can be added on an as needed basis. 
+
+##### Sample Object Type Attributes (for Future)


This area needs to be fleshed out, and could get complicated fast. It's for custom object fields, so some subset of object types above would need to have their custom fields defined.

Could be defined by cities. Can provide examples here.

I think we would be fine to leave this as a list of examples.
Do we have to tie these attributes to specific object types? Or just leave it open for cities as they see fit.

We agreed to remove this entire custom object type attributes section. Make sure references to it are removed from other parts of Objects.

Added in latest commit. I also added this for reference

Unique object type attributes for each object type are not included in this version of the specification. As use of Curb Objects grows or specific use cases become more involved, common object type attributes can be added.

schnuerle · 2024-10-16T21:11:40Z

events/README.md

@@ -106,6 +108,7 @@ A Curb Event is represented as a JSON object, whose fields are as follows:
 | `curb_zone_id` | [UUID][uuid] | Conditionally Required | Unique ID of the Curb Zone where the event occurred. Required for events that occurred at a known Curb Zone for ALL _event_types_. |
 | `curb_area_ids` | Array of [UUID][uuid] | Conditionally Required | Unique IDs of the Curb Area where the event occurred. Since Curb Areas can overlap, an event may happen in more than one. Required for events that occurred in a known Curb Area, if known and used, for these event_types: _enter_area, exit_area, park_start, park_end_ |
 | `curb_space_id` | [UUID][uuid] | Conditionally Required | Unique ID of the Curb Space where the event occurred. Required for events that occurred at a known Curb Space, if known and used, for these event_types: _park_start, park_end, enter_area, exit_area_ |
+| `curb_object_id` | [UUID][uuid] | Conditionally Required | Unique ID of the Curb Object where the event occurred. Required for events that occurred at a known Curb Object, if known and used, for these event_types: _park_start, park_end, enter_area, exit_area_ |


Should this be for multiple IDs, so curb_object_id? One event could use a meter and an EV charger and a locker, for example.

We could list multiple IDs here, although maybe it should only be what the true source of the event is (if you plug into the charger, book the locker, or pay at the meter)? I think leaving it as one option could be cleaner.

Agreed that this can stay as one single ID per event. If multiple objects need to record simultaneous events at a zone, then they each get their own event. So this is fine as is.

schnuerle · 2024-11-05T18:27:43Z

We had a great public working group meeting on this topic. Here are the action items, notes, and recording.

Here were the main consensus items from the 49 attendees, including direct feedback from representatives from CurbIQ, Umojo, Turnstone, INRIX, SFTMA, SDOT, and others.

Remove custom Object Type Attributes from Curb Objects (could come later in 1.2 if it's needed)
Update curb object ids description in Zones to specify it is about the object's area of influence
Update curb zone id description in Objects to specify it is closest location of the object at the zone
Keep curb events object id in Events as is so each object get its own event and details when needed

I'll be flagging the specific PR lines with each of these for @jacobmalleau to edit. If you agree with these, let us know here. If don't agree, let us know too.

schnuerle · 2024-11-05T18:58:15Z

curbs/README.md

@@ -263,6 +308,7 @@ A Curb Zone is represented as a JSON object, whose fields are as follows:
 | `entire_roadway`| Boolean | Optional | If "true", this curb location takes up the entire width of the roadway (which may be impassible for through traffic when the Curb Zone is being used for parking or loading). This is a common condition for alleyways. If `entire_roadway` is `true`, `street_side` MUST NOT be present. |
 | `curb_area_ids`| Array of [UUID][uuid] | Optional | The ID(s) of the [Curb Areas](#curb-area) that this Curb Zone is a part of. If specified, the areas identified MUST be retrievable through the Curb API and its geographical area MUST contain that of the Curb Zone. |
 | `curb_space_ids`| Array of [UUID][uuid] | Optional | The ID(s) of the [Curb Spaces](#curb-space) that this Curb Zone contains. If specified, the spaces identified MUST be retrievable through the Curb API and its geographical area MUST be contained in this Curb Zone. |
+| `curb_object_ids` | Array of [UUID][uuid] | Optional | The ID(s) of the [Curb Objects](#curb-object) that this Curb Zone is related to. If specified, the objects identified MUST be retrievable through the Curb API. Curb Objects can be related to a Curb Space or a Curb Zone. |


This description should specify that the curb objects listed are the objects that are in the zone's 'area of influence'. The Objects that relate to this curb zone. So a locker's ID might be listed in 4 curb zones along a block face. Or a camera's ID might be listed in 3 curb zones that the camera has visibility into. Or the parking meter might be useable by 5 zones on a block.

Added text for this in the latest commit. I am still a little weary of how this can be interpreted (e.g. a camera is located in one curb zone, but monitors several curb zones, how will a user know which is which). But I think with the inverse ID linkage this for an object this should be covered (e.g. you use the Curb Zone ID attribute for Curb Object to specify where the curb object is, then associate it with any zones it covers). Another example: a pay station's Curb Zone ID attribute shows where it is physically, and this field lets you indicate all the curb zones it covers.

schnuerle · 2024-11-05T18:59:43Z

curbs/README.md

@@ -317,6 +363,7 @@ A Curb Space is represented as a JSON object whose fields are as follows:
 | `published_date` | [Timestamp][ts] | Required | The date/time that this curb area was first published in this data feed. |
 | `last_updated_date` | [Timestamp][ts] | Required | The date/time that the properties of ths curb area were last updated. This helps consumers know that some fields may have changed. |
 | `curb_zone_id` | [UUID][uuid] | Required | The ID of the Curb Zone this space is within. The geometry of the specified Curb Zone MUST contain the geometry of this space. |
+| `curb_object_ids` | Array of [UUID][uuid] | Conditionally Required | The ID(s) of the [Curb Objects](#curb-object) that this Curb Space is related to. If specified, the objects identified MUST be retrievable through the Curb API. Curb Objects can be related to a Curb Space or a Curb Zone.|


Similar to the object IDs in a zone, for spaces, this description should specify that the curb objects listed are the objects that are in the space's 'area of influence'. So a meter might be for 2 curb spaces.

Addressed in latest commit

schnuerle · 2024-11-05T19:01:52Z

curbs/README.md

+| ------ | ------ | ------------------- | ------------- |
+| `curb_object_id` | [UUID][uuid] | Required | The ID of the curb object. |
+| `geometry` | [Point][point] | Required |The spatial location of this curb object location. This can represent the approximate center of the object, or the centroid location of the object, depending on its size and shape. |
+| `curb_zone_id` | [UUID][uuid] | Conditionally Required | The ID of the Curb Zone this object is related to. The geometry of the specified Curb Zone does not need to directly relate to the geometry of this object. Either a Zone or Space ID is required for an Object. |


The curb_zone_id description should reflect the idea that the object's physical location is nearest to this zone. Similarly with curb_space_id below.

Added in latest commit

See meeting notes for additional context.

jacobmalleau

Left comments throughout with items addressed in my latest commit

Update README.md

bb4b9e1

First commit / defining Curb Object

jacobmalleau requested a review from a team as a code owner November 20, 2023 01:20

schnuerle added enhancement New feature or request Curbs API Events API Metrics API schema Implications for the OpenAPI Schema labels Nov 20, 2023

schnuerle changed the base branch from feature-curb-objects to dev November 20, 2023 15:56

schnuerle marked this pull request as draft November 20, 2023 15:59

schnuerle linked an issue Nov 20, 2023 that may be closed by this pull request

Add Curb Objects #123

Open

schnuerle mentioned this pull request Nov 20, 2023

Add Curb Objects #123

Open

jacobmalleau and others added 18 commits November 20, 2023 16:47

Update Curb Object Attributes

b33b523

Added object basic properties, well known types, TOC

6adbdbb

Add Objects to Zones and Spaces

5041899

Added more and sorted object types

117e43b

Add objects to events

c43e9de

Adding Objects to Metrics

dbf8bdf

Address Some Comments from Working Group Meeting

864dbe3

- Note centroid of object - Note positive and negative distances - Start to populate type specific attributes

Adding Point GeoJSON

7bb63d1

Add object owner, external id/URL

bed2a3d

Added object endpoints

0f054ff

Added Object Type Attributes

5be93ae

Add operator field & space/zone endpoint parameters

56cf45a

Merged object attributes to types

baacbda

Rearranged required object fields

bc18f7a

Added object shape

0f540e0

Removed duplicate geometry field

399956b

Update README.md

3df4f23

Updated language around Object Type Attributes based on latest discussions. It omits details on specific attributes for future versions of the spec.

Added Objects to Event Endpoints

dce17a8

jacobmalleau added 2 commits March 4, 2024 15:18

Added Objects to Metric Endpoints

97b8ac2

Noted Objects are like Spaces, no previous IDs needed for updates

bc27f1d

schnuerle added this to the 1.1 milestone May 17, 2024

schnuerle reviewed Oct 16, 2024

View reviewed changes

schnuerle reviewed Nov 5, 2024

View reviewed changes

This was referenced Nov 5, 2024

Relational Curb Object, Curb Zone, and Curb Policy (1-to-1 or 1-to-many) #152

Open

Need to add a "Device" attribute to the Curbs API to define devices used in CDS. #147

Open

Updates to Curb Objects Based on October 29th CDS Meeting

c8f5dc0

See meeting notes for additional context.

jacobmalleau commented Nov 7, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Creating Curb Objects #126

Creating Curb Objects #126

jacobmalleau commented Nov 20, 2023 •

edited by schnuerle

Loading

CLAassistant commented Nov 20, 2023 •

edited

Loading

jamesian-barr commented Oct 16, 2024

schnuerle commented Oct 16, 2024 •

edited

Loading

schnuerle Oct 16, 2024 •

edited

Loading

jacobmalleau Oct 28, 2024

schnuerle Nov 5, 2024

jacobmalleau Nov 7, 2024

schnuerle Oct 16, 2024

jacobmalleau Oct 28, 2024

schnuerle Nov 5, 2024

schnuerle commented Nov 5, 2024 •

edited

Loading

schnuerle Nov 5, 2024 •

edited

Loading

jacobmalleau Nov 7, 2024 •

edited

Loading

schnuerle Nov 5, 2024

jacobmalleau Nov 7, 2024

schnuerle Nov 5, 2024

jacobmalleau Nov 7, 2024

jacobmalleau left a comment


		Some object types will have unique, custom attributes that can be optionally included with the given object type. These are given as unordered key-value pairs, e.g. `kilowatts` : `1.21`. For this current version of Curb Objects, specific object type attributes will not be included in the specification. As use of Curb Objects grows or specific use cases become more involved, common object type attributes can be added on an as needed basis.

		##### Sample Object Type Attributes (for Future)

Creating Curb Objects #126

Are you sure you want to change the base?

Creating Curb Objects #126

Conversation

jacobmalleau commented Nov 20, 2023 • edited by schnuerle Loading

Explain pull request

Is this a breaking change

Impacted Spec

Additional context

CLAassistant commented Nov 20, 2023 • edited Loading

jamesian-barr commented Oct 16, 2024

schnuerle commented Oct 16, 2024 • edited Loading

schnuerle Oct 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

schnuerle commented Nov 5, 2024 • edited Loading

schnuerle Nov 5, 2024 • edited Loading

Choose a reason for hiding this comment

jacobmalleau Nov 7, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jacobmalleau left a comment

Choose a reason for hiding this comment

jacobmalleau commented Nov 20, 2023 •

edited by schnuerle

Loading

CLAassistant commented Nov 20, 2023 •

edited

Loading

schnuerle commented Oct 16, 2024 •

edited

Loading

schnuerle Oct 16, 2024 •

edited

Loading

schnuerle commented Nov 5, 2024 •

edited

Loading

schnuerle Nov 5, 2024 •

edited

Loading

jacobmalleau Nov 7, 2024 •

edited

Loading