Skip to content

Commit

Permalink
Update Swagger Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Samsara CI committed Jun 9, 2021
1 parent 533a898 commit 20ff20a
Show file tree
Hide file tree
Showing 4 changed files with 124 additions and 3 deletions.
13 changes: 13 additions & 0 deletions changelog.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1104,6 +1104,19 @@
"IsDocumentationOnly": true
}
},
{
"Route": "fleet/hos/daily-logs",
"Method": "GET",
"Changelog": {
"Index": 4,
"VersionDate": "2018.01.01",
"Description": "Update documentation for GET /fleet/hos/daily-logs",
"Details": "Clarified the difference between dutyStatusDurations and pendingDutyStatusDurations in public docs",
"IsBreakingChange": false,
"IsInitialRelease": false,
"IsDocumentationOnly": true
}
},
{
"Route": "fleet/hos/logs",
"Method": "GET",
Expand Down
2 changes: 1 addition & 1 deletion markdown/gethosdailylogs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;licensePlate**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | The license plate of the vehicle. |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;name**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | Name of the vehicle |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;vehicleVin**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;string_ | The VIN of the vehicle. |
| **&nbsp;&nbsp;&nbsp;&nbsp;pendingDutyStatusDurations**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;object_ | The currently applied duty status durations on the driver's log. |
| **&nbsp;&nbsp;&nbsp;&nbsp;pendingDutyStatusDurations**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;object_ | What the duty status durations on the driver’s log would be if all pending carrier edits are accepted by the driver. |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;activeDurationMs**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;integer_ | Duration the driver was active for in the log period in milliseconds. |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;driveDurationMs**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;integer_ | Duration the driver was driving for in the log period in milliseconds. |
| **&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;offDutyDurationMs**<br/>_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;integer_ | Duration the driver was off duty for in the log period in milliseconds. |
Expand Down
56 changes: 55 additions & 1 deletion swagger-readme.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8978,7 +8978,7 @@
"$ref": "#/components/schemas/LogMetaDataObjectResponseBody"
},
"pendingDutyStatusDurations": {
"$ref": "#/components/schemas/DutyStatusDurationObjectResponseBody"
"$ref": "#/components/schemas/PendingDutyStatusDurationsObjectResponseBody"
},
"startTime": {
"description": "The start time of the daily log in RFC 3339 format. This will be calculated using timezone of the driver.",
Expand Down Expand Up @@ -11574,6 +11574,60 @@
},
"type": "object"
},
"PendingDutyStatusDurationsObjectResponseBody": {
"description": "What the duty status durations on the driver’s log would be if all pending carrier edits are accepted by the driver.",
"properties": {
"activeDurationMs": {
"description": "Duration the driver was active for in the log period in milliseconds.",
"example": 38825000,
"format": "int64",
"type": "integer"
},
"driveDurationMs": {
"description": "Duration the driver was driving for in the log period in milliseconds.",
"example": 31970000,
"format": "int64",
"type": "integer"
},
"offDutyDurationMs": {
"description": "Duration the driver was off duty for in the log period in milliseconds.",
"example": 20555000,
"format": "int64",
"type": "integer"
},
"onDutyDurationMs": {
"description": "Duration the driver was on duty for in the log period in milliseconds.",
"example": 5423000,
"format": "int64",
"type": "integer"
},
"personalConveyanceDurationMs": {
"description": "Duration the driver was driving for personal conveyance for in the log period in milliseconds.",
"example": 4358000,
"format": "int64",
"type": "integer"
},
"sleeperBerthDurationMs": {
"description": "Duration the driver was in their sleeper berth for in the log period in milliseconds.",
"example": 27020000,
"format": "int64",
"type": "integer"
},
"waitingTimeDurationMs": {
"description": "Duration the driver was waiting for in the log period in milliseconds.",
"example": 1560000,
"format": "int64",
"type": "integer"
},
"yardMoveDurationMs": {
"description": "Duration the driver was driving for yard moves for in the log period in milliseconds.",
"example": 1432000,
"format": "int64",
"type": "integer"
}
},
"type": "object"
},
"PostJobObjectRequestBody": {
"description": "Job object to be created",
"properties": {
Expand Down
56 changes: 55 additions & 1 deletion swagger.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18140,7 +18140,7 @@
"$ref": "#/definitions/LogMetaDataObjectResponseBody"
},
"pendingDutyStatusDurations": {
"$ref": "#/definitions/DutyStatusDurationObjectResponseBody"
"$ref": "#/definitions/PendingDutyStatusDurationsObjectResponseBody"
},
"startTime": {
"description": "The start time of the daily log in RFC 3339 format. This will be calculated using timezone of the driver.",
Expand Down Expand Up @@ -20718,6 +20718,60 @@
}
}
},
"PendingDutyStatusDurationsObjectResponseBody": {
"description": "What the duty status durations on the driver’s log would be if all pending carrier edits are accepted by the driver.",
"type": "object",
"properties": {
"activeDurationMs": {
"description": "Duration the driver was active for in the log period in milliseconds.",
"type": "integer",
"format": "int64",
"example": 38825000
},
"driveDurationMs": {
"description": "Duration the driver was driving for in the log period in milliseconds.",
"type": "integer",
"format": "int64",
"example": 31970000
},
"offDutyDurationMs": {
"description": "Duration the driver was off duty for in the log period in milliseconds.",
"type": "integer",
"format": "int64",
"example": 20555000
},
"onDutyDurationMs": {
"description": "Duration the driver was on duty for in the log period in milliseconds.",
"type": "integer",
"format": "int64",
"example": 5423000
},
"personalConveyanceDurationMs": {
"description": "Duration the driver was driving for personal conveyance for in the log period in milliseconds.",
"type": "integer",
"format": "int64",
"example": 4358000
},
"sleeperBerthDurationMs": {
"description": "Duration the driver was in their sleeper berth for in the log period in milliseconds.",
"type": "integer",
"format": "int64",
"example": 27020000
},
"waitingTimeDurationMs": {
"description": "Duration the driver was waiting for in the log period in milliseconds.",
"type": "integer",
"format": "int64",
"example": 1560000
},
"yardMoveDurationMs": {
"description": "Duration the driver was driving for yard moves for in the log period in milliseconds.",
"type": "integer",
"format": "int64",
"example": 1432000
}
}
},
"PostJobObjectRequestBody": {
"description": "Job object to be created",
"type": "object",
Expand Down

0 comments on commit 20ff20a

Please sign in to comment.