Skip to content

Commit

Permalink
Document allowed text/plain MIME type for device log content.
Browse files Browse the repository at this point in the history
  • Loading branch information
lostlevels committed Sep 10, 2024
1 parent b43ea22 commit 738ad33
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 5 deletions.
14 changes: 9 additions & 5 deletions reference/blob.v1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ paths:
post:
operationId: UploadDeviceLogs
summary: Upload new device logs as json
description: Uploads a new device logs json to the user's account. The `Digest` header must represent the MD5 hash of the json data content.
description: Uploads new device logs to the user's account. The `Digest` header must represent the MD5 hash of the data.
parameters:
- $ref: ./common/parameters/digestmd5.v1.yaml
- $ref: ./blob/parameters/logs-start-at.v1.yaml
Expand All @@ -66,9 +66,10 @@ paths:
content:
application/json:
schema:
type: array
items:
$ref: ./blob/models/device-log-content.v1.yaml
$ref: ./blob/models/device-log-content-list.v1.yaml
text/plain:
schema:
$ref: ./blob/models/device-log-content-plain.v1.yaml
responses:
'201':
$ref: '#/components/responses/DeviceLogsMetadata'
Expand Down Expand Up @@ -310,8 +311,11 @@ components:
application/json:
schema:
$ref: ./blob/models/device-log-content-list.v1.yaml
text/plain:
schema:
$ref: ./blob/models/device-log-content-plain.v1.yaml
DeviceLogsMetadata:
description: Device logs metadata
description: Device logs metadata. This is information about the log data, but is not the actual log data.
content:
application/json:
schema:
Expand Down
7 changes: 7 additions & 0 deletions reference/blob/models/device-log-content-plain.v1.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
title: Unstructured device log content
description: >-
Device log entry.
type: string
example: >-
Any kind of arbritrary log data sent by a device. Establishing
connection... Connection established. Sending logs...

0 comments on commit 738ad33

Please sign in to comment.