An open API service indexing awesome lists of open source software.

https://github.com/arenadata/truly_automated_tests

Sample project for "Truly automated testing" concept demo
https://github.com/arenadata/truly_automated_tests

Last synced: 6 months ago
JSON representation

Sample project for "Truly automated testing" concept demo

Awesome Lists containing this project

README

          

# 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/\/**
- **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](#cluster)
filesystem_id | `integer` | `True` | FK to [File system](#file-system)

### Backup

Create backup of cluster to file system.

> [Connection](#connection) for given [Cluster](#cluster) and [File system](#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](#cluster)
filesystem_id | `integer` | `True` | FK to [File system](#file-system)