A Registry for published WebPipes.
CoffeeScript CSS JavaScript
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
assets
.gitignore
Procfile
README.md
config.coffee
index.coffee
package.json

README.md

WebPipe Registry

A registry of published WebPipes.

Introduction

This registry exists as place for developers to leverage WebPipes and share their own with the community. All registered WebPipes are required to conform to the WebPipe Specification.

API

GET /blocks[.json]

Returns all registered WebPipes.

Example
curl -i -X GET http://registry.webpipes.org/blocks.json

GET /blocks/:slug[.json]

Returns a single Block Definition.

Arguments
Parameter Name Description
slug A slug for a Block
Example
curl -i -X GET http://registry.webpipes.org/blocks/parse-markdown.json

POST /blocks

Register a WebPipe.

Arguments
Parameter Name Description
url An URL to a Block Definition
Example
curl -i -X POST -d 'url=http://block-endpoint' http://registry.webpipes.org/blocks

Issues

  • No HTTP Method PUT - Should registries automatically poll? PUT might be nice for manual update of block definition.
  • No HTTP Method DELETE - Developers ought to be able to remove their published WebPipes.
  • Should the Block Definition include a key for which version of the specification is implemented?
  • Keys are not protected. Need a way to prevent users from overwriting each other's plugins if that key-name already exists.
  • How to handle name versus slug?
  • Testing