Skip to content
Adversarial

Approve or deny an open proposal

PATCH
/v1/documents/{id}/proposal

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Document ID

Example
ramp

Request Body required

Section titled “Request Body required ”

Defines in a modification or creation standpoint, what happens to a proposal

todo: fix this doc

string
Allowed values: approve deny

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Proposal decided on

object
created
required

A common attribute of several structs that identifies a person and time where information is utilized in some capacity

object
by
One of:
null
date
required
string format: date-time
decision
One of:
null
document
required

A slug and version pair that uniquely identifies a document.

As a string, the format should be slug:version, where slug is a string that is a valid slug and version is a string that is a valid version.

Example

# use std::str::FromStr;
# use backend::views::document::{DocumentId, Version};
# use backend::views::common::Slug;

let document_id_str = "cybersecurity-policy:1.0.0";
let document_id: DocumentId = DocumentId::from_str(document_id_str).unwrap();
assert_eq!(document_id.slug.as_str(), "cybersecurity-policy");
assert_eq!(document_id_str.to_string(), DocumentId::new(Slug::from_str("cybersecurity-policy").unwrap(), Version::new(1, 0, 0)).to_string());
object
slug
required

The slug of the document. i.e. cybersecurity-policy

string
version
required

The version of the document. i.e. 1.0.0

Array<integer>
>= 3 items <= 3 items
id
required
integer format: int32

400

Section titled “400 ”

No open proposal exists