Skip to content

Latest commit

 

History

History
41 lines (32 loc) · 1.67 KB

README.md

File metadata and controls

41 lines (32 loc) · 1.67 KB

Pipeforge Rest Api

Purpose

Exposes services for interacting with Pipeforge through rest endpoints.

Requirements

Installation

Pipewrench must be installed on the host running the rest service.

Configuration

Pipewrench Environment and Configuration files are written to a configured directory. This directory should contain a copy of Pipewrench templates and the generate-scripts.sh file.

Endpoints

Postman File

/pipewrench

GET

Basic text response endpoint.

/pipewrench/merge

POST

Executes pipewrench-merge

Parameters
  • template: Pipewrench template to be used when executing the merge
Body

A complete Pipewrench Configuration

Output
  • A pipewrench output directory is written to {pipewrench.directory.output}/{group}/{name}/output

/pipewrench/configuration

PUT

Produces a Pipewrench Configuration from database metadata.

Body

Pipeforge Environment json Example

/pipewrench/environment

POST

Saves a Pipewrench Environment file to the configured directory.

Body

Pipeforge Environment json Example