Skip to content
Changeset Second Opinion

A draft comment with its validation result

GET
/api/v1/drafts/{id}
curl --request GET \
  --url https://example.com/api/v1/drafts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

Draft text and the tone check it passed or failed.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
Id
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Draft

A comment candidate with its validation result; a person edits and posts it.

object
body
required
Body
string
cited_evidence_ids
Cited Evidence Ids
Array<string>
closing
required
Closing
string
created_at
required
Created At
string format: date-time
greeting
required
Greeting
string
id
required
Id
string format: uuid
model_id
Any of:
string
response_type
required
Response

Q2 option set: suggested next step for the reviewer.

string
Allowed values: no_action_suggested welcome_and_tips ask_source_question request_local_check escalate_to_experienced_reviewer
run_id
required
Run Id
string format: uuid
status
required
DraftStatus

Validation outcome of a drafted comment.

string
Allowed values: generated validated rejected_by_validator template_fallback
validation
required
DraftValidation

Result of validating a draft against tone rules.

object
ok
required
Ok
boolean
violations
Violations
Array<string>

Example 

{
  "response_type": "no_action_suggested",
  "status": "generated"
}

404

Section titled “404”

Not Found

Problem

Application/problem+json body. Extension members (for example job_id) are allowed.

object
detail
Any of:
string
errors
Any of:
Array<object>
FieldError

One validation failure: where, what, and a stable machine code (never the input value).

object
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
instance
Any of:
string
request_id
required
Request Id
string
status
required
Status
integer
title
required
Title
string
type
Type
string
default: about:blank
key
additional properties
any

Example 

{
  "type": "about:blank"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}

Map data © OpenStreetMap contributors, under the Open Database Licence. Code under the Apache-2.0 licence. Made by Yogesh.

Changeset Second Opinion is an independent open source tool for OpenStreetMap reviewers. It is not endorsed by, sponsored by or affiliated with the OpenStreetMap Foundation. OpenStreetMap is a trademark of the OpenStreetMap Foundation, used under itstrademark policy.