Livingdocs OpenAPI Specification

OpenAPI 3 specification for Livingdocs Public API

This file makes it easy to test and share our API enpoints.

It's available here

Supported environments

localhost
Livingdocs demo at edit.livingdocs.io, deprecated from release-2023-09

How to use it

The OpenAPI spec is hosted by Github pages at:

https://livingdocsio.github.io/openapi/livingdocs-openapi.json

This can be imported in Insomnia or Postman to have a full collections of API enpoints to test.

Alternatively the same can be done with online tools. You just need to paste the OpenAPI spec url in one of the following tools.

Swagger UI

Swagger Editor

Some other tools

OpenAPI Tools list of useful tools related to OpenAPI

ApiTree hosted API documentation based on OpenAPI

OpenDocumenter: for creating a documentation from OpenAPI spec

How to develop

Import the livingdocs-openapi.json file into insomnia as a design document, here you can test the APIs and add new endpoints. For authenticated requests you need an API token from your Livingdocs project.

Alternatively you can do everything in VS Code using the OpenAPI (Swagger) Extension.

Example endpoint

  /channels/{channelHandle}:
      get:
        security:
        - bearerAuth: [public-api:read]
        parameters:
        - name: channelHandle
          in: path
          description: Optional channelHandle. Will return first channel of a project if none is passed.
          required: true
          schema:
            type: string
            example: ""
        tags:
          - Project
        summary: details and configuration of this project.
        operationId: getChannel
        responses:
          "200":
           description: ok

How to contribute

Keep the same structure as our documentation docs. Many API endpoints are still missing. Please mark the category as completed when all its endpoints are registered in the spec.

Project ✅
Composition API ✅
Publications ✅
Search ✅
Document Lists ✅
Document Categories ✅
Media Library ✅
Imports ✅
Sitemaps ✅
Menus ✅
Routing ✅
Add Delivery Status ✅
Health ✅

TODOs and future ideas

add all the Public API endpoints from our docs ✅
make available the OAS publicly ✅
embedd the Swagger UI in our docs
support to extend downstream with downstream declaration
generate the spec by the server

lucax88x/openapi