docs(http): add 422 response for writes where points outside of RP

pull/10616/head
Chris Goller 2018-08-26 12:54:12 -05:00
parent 957e3f72ae
commit 42f6b278e4
1 changed files with 33 additions and 4 deletions

View File

@ -81,7 +81,7 @@ paths:
'204':
description: write data is correctly formatted and accepted for writing to the bucket.
'400':
description: line protocol poorly formed and no points were written. Response can be used to determine the first malformed line in the body line-protocol.
description: line protocol poorly formed and no points were written. Response can be used to determine the first malformed line in the body line-protocol. All data in body was rejected and not written.
content:
application/json:
schema:
@ -99,11 +99,17 @@ paths:
schema:
$ref: "#/components/schemas/Error"
'413':
description: write has been rejected because the payload is too large. Error message returns max size supported.
description: write has been rejected because the payload is too large. Error message returns max size supported. All data in body was rejected and not written.
content:
application/json:
schema:
$ref: "#/components/schemas/LineProtocolLengthError"
'422':
description: write has been rejected because the because one or more lines contain timestamps older than retentionPeriod. Response has the retentionPeriod and the line that is too old. All data in body was rejected and not written.
content:
application/json:
schema:
$ref: "#/components/schemas/LineProtocolRetentionPolicyError"
'429':
description: token is temporarily over quota. The Retry-After header describes when to try the write again.
headers:
@ -1511,7 +1517,7 @@ components:
type: string
line:
readOnly: true
description: line within sent body containing malformed data
description: first line within sent body containing malformed data
type: integer
format: int32
required: [code, message, op, err]
@ -1532,7 +1538,30 @@ components:
description: max length in bytes for a body of line-protocol.
type: integer
format: int32
required: [code, message, op, err]
required: [code, message, maxLength]
LineProtocolRetentionPolicyError:
properties:
code:
description: code is the machine-readable error code.
readOnly: true
type: string
enum:
- invalid
message:
readOnly: true
description: message is a human-readable message.
type: string
line:
readOnly: true
description: first line within sent body containing data outside of retentionPeriod.
type: integer
format: int32
retentionPeriod:
readOnly: true
description: describes the maximum duration in nanoseconds in the past a point is acceptable without rejection.
type: integer
format: int64
required: [code, message, line, retentionPeriod]
InfluxQLResults:
properties:
error: