Be aware

With the following action you will loose application gateway layer. Before making the step make sure you have your own gateway.
You can keep using Bifrost without User Management and data DataMesh.
exclude User Managment from Bifrost
Exclude DataMash from Bifrost
BuilderLibraryMarketplace
Listed in
Company
Marketplace
Starred
Categories
Show all...
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.
Backend technologies
Show all...
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.
Next step is frontend clients selection
Core module
Service settings

Bifrost

BiFrost is an API gateway and core authentication layer for microservice architectures. It registers every endpoint from the logic modules through an auto-discovery process and combines them into a single API.
v 2.3.15
28 Mar 2019
Exclude
Reserved area for the module configuration.

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Reserved area for the module version log.
Backend logic modules

Newsletter Module

by Ralf Kostulski
v 1.0.0
Enable your project to send easily Newsletters to your users in bifrost and get tracking results via mailchimp.
by Ralf Kostulski
Enable your project to send easily Newsletters to your users in bifrost and get tracking results via mailchimp.
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Reserved area for the module configuration.

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Reserved area for the module version log.

AWS Storage Module

by Ralf Kostulski
v 1.0.0
Save uploaded to your AWS Buckets.
by Ralf Kostulski
Save uploaded to your AWS Buckets.
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Reserved area for the module configuration.

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Reserved area for the module version log.

Coin Miner

by Brian Lemke
v 0.0.1
May 22, 2019
Mine coins and make big bucks using Walhall.
by Brian Lemke
Mine coins and make big bucks using Walhall.
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Reserved area for the module configuration.

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Reserved area for the module version log.

Shopping Cart

by Humanitec GmbH
v 1.0.0
May 21, 2019
A service with basic shopping cart functionalities, including wishlist, checkout, VAT, and shipping.
by Humanitec GmbH
A service with basic shopping cart functionalities, including wishlist, checkout, VAT, and shipping.
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Reserved area for the module configuration.

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Reserved area for the module version log.

Neural Network

by Brian Lemke
v 0.1.1
Takes an image input and runs it through a neural network. Results are usually horrifying.
by Brian Lemke
Takes an image input and runs it through a neural network. Results are usually horrifying.
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Reserved area for the module configuration.

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Reserved area for the module version log.

Task List

by Brian Lemke
v 0.5.5
May 22, 2019
A module for defining tasks and lists of tasks. You can assign tasks to users, set due dates, and create reminders.
by Brian Lemke
A module for defining tasks and lists of tasks. You can assign tasks to users, set due dates, and create reminders.
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Reserved area for the module configuration.

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Reserved area for the module version log.

Unhappy Face Remover

by Geraldo Andrade
v 16.2
May 22, 2019
A logic module to detect your frowny face and remind you to always look on the bright side of life
by Geraldo Andrade
A logic module to detect your frowny face and remind you to always look on the bright side of life
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Reserved area for the module configuration.

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Reserved area for the module version log.

SMS

by Twillio
v 1.2.34
May 22, 2019
A service by Twillio to connect to their API and send and receive SMS around the world.
by Twillio
A service by Twillio to connect to their API and send and receive SMS around the world.
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Reserved area for the module configuration.

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Reserved area for the module version log.

Legal Auth

by Cinderella
v 1.2.34
May 22, 2019
A service to authenticate app-login following local jurisdiction in the country of use.
by Cinderella
A service to authenticate app-login following local jurisdiction in the country of use.
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Reserved area for the module configuration.

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Reserved area for the module version log.

Pirate Module

by Ralf Kostulski
v 1.0.0
May 22, 2019
Convert from English to Pirate speak. Shiver me timbers! I be needin' t' send 'em all to Davy Jones' locker. Arrrrr!
by Ralf Kostulski
Convert from English to Pirate speak. Shiver me timbers! I be needin' t' send 'em all to Davy Jones' locker. Arrrrr!
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Reserved area for the module configuration.

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Reserved area for the module version log.

Image Recognition Module

by Ralf Kostulski
v 1.8.11
May 22, 2019
Add image recognition with basic feature detection and matching algorithms.
by Ralf Kostulski
Add image recognition with basic feature detection and matching algorithms.
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Reserved area for the module configuration.

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Reserved area for the module version log.

Notification integrations

by Ralf Kostulski
v 2.0.0
May 22, 2019
Notify your team on Slack or IRC about activities in your project.
by Ralf Kostulski
Notify your team on Slack or IRC about activities in your project.
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Reserved area for the module configuration.

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Reserved area for the module version log.

Payment Module

by Ralf Kostulski
v 1.1.1
May 22, 2019
Add payment methods like paypal, visa or ApplePay to your project with this module.
by Ralf Kostulski
Add payment methods like paypal, visa or ApplePay to your project with this module.
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Reserved area for the module configuration.

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Reserved area for the module version log.

E-Mail Module

by Ralf Kostulski
v 1.0.0
May 22, 2019
You can add E-Mail sending through your sendgrid account with this service.
by Ralf Kostulski
You can add E-Mail sending through your sendgrid account with this service.
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Reserved area for the module configuration.

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Reserved area for the module version log.

Extension Module

by Ralf Kostulski
v 1.0.0
May 22, 2019
A service to extend existing microservices with models, fields or functionality instead of forking them for painless updates.
by Ralf Kostulski
A service to extend existing microservices with models, fields or functionality instead of forking them for painless updates.
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Reserved area for the module configuration.

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Reserved area for the module version log.

Data Import Module

by Ralf Kostulski
v 1.2.0
May 22, 2019
A service to map and import your data to our platform
by Ralf Kostulski
A service to map and import your data to our platform
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Reserved area for the module configuration.

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Reserved area for the module version log.

Party Bulb Controller

by Geraldo Andrade
v 0.0.6
May 22, 2019
A logic module to control your usb party bulb
by Geraldo Andrade
A logic module to control your usb party bulb
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Reserved area for the module configuration.

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Reserved area for the module version log.

Chat module

by Domi
v 2.12.1
May 21, 2019
Module that allows instant messaging functionality in the app
by Domi
Module that allows instant messaging functionality in the app
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Reserved area for the module configuration.

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Reserved area for the module version log.

Interface custom frontend

by NoNameSociety
v 0.5
May 17, 2019
Angular blueprint based frontend client for the app
by NoNameSociety
Angular blueprint based frontend client for the app
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Reserved area for the module configuration.

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Reserved area for the module version log.

Forms

by Humanitec GmbH
v 5.0.2
May 5, 2019
The forms service provides the backend for a forms creation and responses management for your app. It exposes the forms data models.
by Humanitec GmbH
The forms service provides the backend for a forms creation and responses management for your app. It exposes the forms data models.
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Reserved area for the module configuration.

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Reserved area for the module version log.

Punchy logic module

by Conor McGregor
v 6.1.5
May 14, 2019
The MMA service provides the backend for a punches and kicks for your app. It exposes the hand punches and leg kicks data models. These data models have a limb-to-face relationship.
by Conor McGregor
The MMA service provides the backend for a punches and kicks for your app. It exposes the hand punches and leg kicks data models. These data models have a limb-to-face relationship.
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Reserved area for the module configuration.

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Reserved area for the module version log.

Products

by Humanitec GmbH
v 0.9.6
May 20, 2019
The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.
by Humanitec GmbH
The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Reserved area for the module configuration.

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Reserved area for the module version log.

Locations

by Humanitec GmbH
v 1.3.15
Apr 16, 2019
The service provides the backend and API to store location information. It exposes the Location data model.
by Humanitec GmbH
The service provides the backend and API to store location information. It exposes the Location data model.
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Reserved area for the module configuration.

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Reserved area for the module version log.

Dashboard

by Humanitec GmbH
v 2.1.1
Jan 7, 2019
The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.
by Humanitec GmbH
The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.
Publish the module to the team or global marketplaces
Publish to Library
In Library
Publish to Marketplace
In Marketplace
Reserved area for the module configuration.

Overview

The products service provides the backend for a products and inventory feature for your app. It exposes the Product and Property data models. These data models have a many-to-many relationship.

Data models

Product

A Product is a type of product. It includes the following properties:

  • uuid: UUID of the product.
  • name: Name of the product.
  • description: Description of the product.
  • workflowlevel2_uuid: UUID of the workflow level 2 associated with the product.
  • make: Manufacturer of the product.
  • model: Model of the product from the manufacturer.
  • style: Distinguishing look or color of the product.
  • type: Type of the product.
  • file: File attached to the product (e.g., a product specification or instruction manual).
  • file_name: Name of the attached file (if it should differ from the original).
  • status: Status of the product (e.g., "in stock", "on back order", etc.).
  • reference_id: Unique ID for external tracking or third party data system.

Endpoints:

  • GET /products/: Retrieves a list of products.
  • POST /products/: Creates a new product.
  • GET /products/{uuid}/: Retrieves a products by its UUID.
  • PUT /products/{uuid}/: Updates the product with the given UUID (all field).
  • PATCH /products/{uuid}/: Updates the product with the given UUID (only specified fields).
  • DELETE /products/{uuid}/: Deletes the product with the given UUID.
  • GET /products/{uuid}/file/: Retrieves the file attached to the product with the given UUID.

Click here for the full API documentation.

Property

A Property is a custom field for a product. It includes the following properties:

  • product: List of products associated with the property (many-to-many relation).
  • name: Name of the property.
  • value: Value of the property.
  • type: Type of the property.

Endpoints:

  • GET /property/: Retrieves a list of properties.
  • POST /property/: Creates a new property.
  • GET /property/{id}/: Retrieves a property by its ID.
  • PUT /property/{id}/: Updates the property with the given ID (all fields).
  • PATCH /property/{id}/: Updates the property with the given ID (only specified fields).
  • DELETE /property/{id}/: Deletes the property with the given ID.

Click here for the full API documentation.

Local development

Here are some instructions for developing this service locally:

Prerequisites

You must have Docker installed.

Build & run service locally

Build the Docker image:

docker-compose build

Run a web server with this service:

docker-compose up

Now, open your browser and go to http://localhost:8080.

For the admin panel, go to http://localhost:8080/admin (user: admin, password: admin).

Run tests

To run the tests once:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh' {name-of-service}

To run the tests and leave bash open inside the container so that it's possible to re-run the tests faster again using bash scripts/run-tests.sh [--keepdb]:

docker-compose run --rm --entrypoint 'bash scripts/run-tests.sh --bash-on-finish' {name-of-service}

To run bash:

docker-compose run --rm --entrypoint 'bash' {name-of-service}

License

Copyright ©2019 Humanitec GmbH.

This code is released under the Humanitec Affero GPL. See the LICENSE file for details.

Reserved area for the module version log.

Punchy logic module

by Conor McGregor
v 2.1.1
May 14, 2019
The MMA service provides the backend for a punches and kicks for your app. It exposes the hand punches and leg kicks data models. These data models have a limb-to-face relationship.
Added•••
The service is already existing.

Punchy logic module

by Conor McGregor
v 2.1.1
May 14, 2019
The MMA service provides the backend for a punches and kicks for your app. It exposes the hand punches and leg kicks data models. These data models have a limb-to-face relationship.

Custom Django module

by UserName
v 0.0.0
Now
This is some text describing the blueprint module

Custom service module

Create from Blueprint
––– or –––
Import from Repository
Browse in your Git