/truly_automated_tests

Sample project for "Truly automated testing" concept demo

Primary LanguagePythonMIT LicenseMIT

Truly automated tests example

Sample project for "Truly automated testing" concept demo

API Spec

Methods

  • /endpoint/
    • GET - List all objects. Will be called LIST in further mentions
    • POST - Create an object. Will be called POST in further mentions
  • /endpoint/<obj_id>/
    • GET - Get exact object data. Will be called GET in further mentions

Types

  • integer
    • Positive integer value < 231
  • string
    • String up to 255 symbols
  • text
    • String with to 2000 symbols

Cluster

DB cluster object

Endpoint: /cluster/

Allowed methods

Name Allowed
GET True
LIST True
POST True

Fields

Name Type Required Description
id integer False Auto generated Object Id
name string True Cluster name
description text False Cluster description for UI

File system

File system for backup storage

Endpoint: /file-system/

Allowed methods

Name Allowed
GET True
LIST True
POST True

Fields

Name Type Required Description
id integer False Auto generated Object Id
name string True File system name
description text False File system description for UI

Connection

Connection between a cluster and filesystem

Endpoint: /connection/

Allowed methods

Name Allowed
GET True
LIST True
POST True

Fields

Name Type Required Description
id integer False Auto generated Object Id
name string True Connection name
cluster_id integer True FK to Cluster
filesystem_id integer True FK to File system

Backup

Create backup of cluster to file system.

Connection for given Cluster and File system should exist before backup creation

Endpoint: /backup/

Allowed methods

Name Allowed
GET True
LIST True
POST True

Fields

Name Type Required Description
id integer False Auto generated Object Id
name string True Backup name
cluster_id integer True FK to Cluster
filesystem_id integer True FK to File system