Skip to content

Commit

Permalink
[Event-Grid Maps] Add Maps publisher schema to EventGrid data-plane (#…
Browse files Browse the repository at this point in the history
…5140)

* Include Microsoft.Maps in readme.md

* [Maps] Updated Event Grid publisher data schema
  • Loading branch information
jp94 authored and sarangan12 committed Feb 11, 2019
1 parent 380e8e5 commit 0f3eefe
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 52 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@
"type": "object",
"description": "Schema of the Data property of an EventGridEvent for a Geofence event (GeofenceEntered, GeofenceExited, GeofenceResult).",
"properties": {
"details": {
"description": "List details generated during processing.",
"expiredGeofenceGeometryId": {
"description": "Lists of the geometry ID of the geofence which is expired relative to the user time in the request.",
"type": "array",
"items": {
"$ref": "#/definitions/MapsGeofenceDetail"
"type": "string"
}
},
"geometries": {
Expand All @@ -51,75 +51,47 @@
"items": {
"$ref" : "#/definitions/MapsGeofenceGeometry"
}
},
"invalidPeriodGeofenceGeometryId": {
"description": "Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.",
"type": "array",
"items": {
"type": "string"
}
},
"isEventPublished": {
"description": "True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber.",
"type": "boolean"
}
}
},
"MapsGeofenceGeometry": {
"description": "The geofence geometry.",
"type": "object",
"properties": {
"udId": {
"description": "The unique ID returned from user upload service when uploading a geofence.",
"deviceId": {
"description": "ID of the device.",
"type": "string"
},
"distance": {
"description": "Distance from the coordinate to the closest border of the geofence. Positive means the coordinate is outside of the geofence. If the coordinate is outside of the geofence, but more than the value of searchBuffer away from the closest geofence border, then the value is 999. Negative means the coordinate is inside of the geofence. If the coordinate is inside the polygon, but more than the value of searchBuffer away from the closest geofencing border,then the value is -999. A value of 999 means that there is great confidence the coordinate is well outside the geofence. A value of -999 means that there is great confidence the coordinate is well within the geofence.",
"type": "number"
},
"geometryId": {
"description": "The unique ID for the geofence geometry.",
"type": "string"
},
"distance": {
"description": "Distance from the coordinate to the closest border line of the polygon, point or point on the polyline. If the coordinate is outside, then the distance is positive. Negative means the coordinate is inside. If the coordinate is inside the polygon, but more than the value of searchBuffer away from the closest polygon border line, point or polyline, then the value is -999. A value of -999 means that there is great confidence the coordinate is well within the geofence.",
"type": "number"
},
"nearestLat": {
"description": "Latitude of the nearest point of the geometry/geometry border. Void if distance = -999.",
"description": "Latitude of the nearest point of the geometry.",
"type": "number"
},
"nearestLon": {
"description": "Longitude of the nearest point of the geometry/geometry border. Void if distance = -999.",
"description": "Longitude of the nearest point of the geometry.",
"type": "number"
}
}
},
"MapsGeofenceDetail": {
"description": "Lists detail generated during processing.",
"type": "object",
"properties": {
"code": {
"description": "The detail code which identifies each detail item being returned.",
"type": "string",
"enum": [
"ExpiredGeofencingData",
"GeofencingEventPublished",
"InvalidTimeGeofencingData"
],
"x-ms-enum": {
"name": "MapsGeofenceDetailCodeType"
}
},
"message": {
"description": "Text description of the detail.",
"udId": {
"description": "The unique id returned from user upload service when uploading a geofence. Will not be included in geofencing post API.",
"type": "string"
},
"type": {
"description": "The type of the detail.",
"type": "string",
"enum": [
"Information",
"Warning"
],
"x-ms-enum": {
"name": "MapsGeofenceDetailType",
"values": [
{
"value": "Information",
"description": "Useful information to inform clients."
},
{
"value": "Warning",
"description": "The detail serves as a warning to client."
}
]
}
}
}
}
Expand Down
1 change: 1 addition & 0 deletions specification/eventgrid/data-plane/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ input-file:
- Microsoft.ContainerRegistry/stable/2018-01-01/ContainerRegistry.json
- Microsoft.ServiceBus/stable/2018-01-01/ServiceBus.json
- Microsoft.Media/stable/2018-01-01/MediaServices.json
- Microsoft.Maps/stable/2018-01-01/Maps.json
```

---
Expand Down

0 comments on commit 0f3eefe

Please sign in to comment.