Home platformOS Logo

API Reference

Last edit: Jul 22, 2020

This section provides API Reference Documentation for the APIs you'll use when developing on platformOS.

Complete Guide to Liquid Markup

Liquid (or Liquid markup) is a template language used in platformOS to build dynamic pages, and to provide dynamic configuration.

Inspired by the official documentation, we divided our Liquid documentation into multiple parts for easy access, keeping it logical for newcomers. We start with an introduction, then describe types, tags grouped into three larger sections (variables, flow control, and loops), filters, objects, and whitespace control.

We have added platformOS-specific filters and tags that you can use when developing on platformOS. You should start learning about these when you’re comfortable with Liquid in general. We added a lot of custom filters and tags that make dealing with Liquid, dates, JSON, data structures, encoding, or URL templates easier. platformOS gives you the power to improve your code by exposing the Liquid profiler and giving you a filter that measures the execution time of any given block with a 1ms granularity.

Our complete guide to Liquid markup includes:

Tip

Interested in why we use Liquid or what sources we used for our documentation? Read our article titled A Complete Guide to Liquid Markup (in platformOS) on the platformOS blog.

GraphQL API

GraphQL is query language used to communicate with our data storages. Our GraphQL API Reference includes:

  • Glossary
  • Queries
  • Mutations
  • Objects
  • Scalars
  • Interfaces
  • Enums
  • Inputs

We also provide a guide on how to effectively use the pos-cli while developing GraphQL queries in platformOS.

Contribute to this page

Github Icon

Questions?

We are always happy to help with any questions you may have.

contact us