List documents

GET

/v1/documents

• Production
• Staging
• Local

Responses

200

List all documents

Contains a list of [DocumentInfo]s.

This is the primary view model for the compliance module.

Array<object>

Provides basic information about a document.

object

description

required

string

latest_version

required

A version number that follows the semantic versioning scheme.

Example

# use std::str::FromStr;
# use backend::views::document::Version;
let version_str = "1.0.0";
let version: Version = Version::from_str(version_str).unwrap();
assert_eq!(version.to_string(), "1.0.0");

Array<integer>

>= 3 items <= 3 items

slug

required

string

Example

cybersecurity-policy

state

required

One of:

object

The document has not been initialized yet. It is possible for the document to have details, meaning that a proposal is “open” to initialize it.

object

value

required

string

Allowed values: uninitialized

object

The initial proposal is being opened

object

details

required

The initial proposal is being opened

object

last_approved_action

One of:

null

null

object

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

object

by

One of:

null

null

string

string format: uuid

date

required

string format: date-time

last_modified_action

One of:

null

null

object

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

object

by

One of:

null

null

string

string format: uuid

date

required

string format: date-time

status

required

One of:

object

There are no open changes to the document

object

changes

required

string

Allowed values: no_changes

object

There are open changes to the document

object

changes

required

string

Allowed values: open_changes

value

required

There are open changes to the document

integer format: int32

version

required

A version number that follows the semantic versioning scheme.

Example

# use std::str::FromStr;
# use backend::views::document::Version;
let version_str = "1.0.0";
let version: Version = Version::from_str(version_str).unwrap();
assert_eq!(version.to_string(), "1.0.0");

Array<integer>

>= 3 items <= 3 items

value

required

string

Allowed values: pending_initialization

object

The document has been initialized and is ready for use

object

details

required

The document has been initialized and is ready for use

object

last_approved_action

One of:

null

null

object

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

object

by

One of:

null

null

string

string format: uuid

date

required

string format: date-time

last_modified_action

One of:

null

null

object

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

object

by

One of:

null

null

string

string format: uuid

date

required

string format: date-time

status

required

One of:

object

There are no open changes to the document

object

changes

required

string

Allowed values: no_changes

object

There are open changes to the document

object

changes

required

string

Allowed values: open_changes

value

required

There are open changes to the document

integer format: int32

version

required

A version number that follows the semantic versioning scheme.

Example

# use std::str::FromStr;
# use backend::views::document::Version;
let version_str = "1.0.0";
let version: Version = Version::from_str(version_str).unwrap();
assert_eq!(version.to_string(), "1.0.0");

Array<integer>

>= 3 items <= 3 items

value

required

string

Allowed values: initialized

title

required

string