Code Monkey home page Code Monkey logo

url-arbiter's Introduction

URL Arbiter

Minimal API to arbitrate URLs on GOV.UK. This maintains a list of all the URL paths in use on GOV.UK, and for each one records which publishing app owns that path.

API Endpoints

Getting details about a path

To get details of a path:

curl http://url-arbiter-api.example.com/paths/foo/bar

This will return details of the reserved path as JSON - eg:

{
  "path": "/foo/bar",
  "publishing_app": "foo_publisher",
  "created_at": "2014-08-13T13:25:17.184Z",
  "updated_at": "2014-08-13T13:25:17.184Z"
}

Reserving a path

To reserve a path:

curl http://url-arbiter-api.example.com/paths/foo/bar -X PUT \
    -H 'Content-type: application/json' \
    -d '{"publishing_app": "foo_publisher"}'

This will return a 200 or 201 status on success along with JSON details as above.

A 409 status will be returned if the path has already been reserved by a different publishing application.

A 422 status will be returned for any validation errors.

These errors will also include a JSON response including an "errors" field with any error messages.

url-arbiter's People

Contributors

alext avatar bradwright avatar dhwthompson avatar vinayvinay avatar danielroseman avatar jamiecobbett avatar evilstreak avatar boffbowsh avatar tommyp avatar elliotcm avatar benilovj avatar tekin avatar

Watchers

Chris Roos avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.