Prototype of REST tags.

I've implemented a REST style taggings on the http://api.opensupporter.org/

Create a new tag

To create a tag, send a json document containing the tag name and description

Request

curl -X POST -d @tagcreate.json http://api.opensupporter.org/api/v1/tags

/* tagcreate.json */
{
     "name" : "acme-team",
     "description" : "Indicates a member of the acme team"
}

Response

{
  "name": "acme-team",
  "description": "Indicates a member of the acme team",
  "updated_at": "2014-04-18T19:15:31Z",
  "created_at": "2014-04-18T19:15:31Z",
  "_embedded": {
  },
  "_links": {
    "self": {
      "href": "http://api.opensupporter.org/api/v1/tags/8"
    }
  }
}

Finding a tag reference for use in tagging by using odata query

curl -v -G --data-urlencode "filter=name eq 'acme-team'" "http://localhost:3000/api/v1/tags"

Response

{
  "per_page": 1,
  "page": 1,
  "total_records": 1,
  "_embedded": {
    "osdi:tags": [
      {
        "name": "acme-team",
        "description": "Indicates a member of the acme team",
        "updated_at": "2014-04-18T19:15:31Z",
        "created_at": "2014-04-18T19:15:31Z",
        "_embedded": {
        },
        "_links": {
          "self": {
            "href": "http://api.opensupporter.org/api/v1/tags/8"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "http://api.opensupporter.org/api/v1/tags"
    }
  }
}

Add a tagging

Lets tag a user with the new tag User: Martha Stewart, url: http://api.opensupporter.org/api/v1/people/69/taggings

curl -X POST -d @../taggingcreate.json http://api.opensupporter.org/api/v1/people/69/taggings

Request

{
     "_links" : {
          "osdi:tag" : {
               "href" : "http://api.opensupporter.org/api/v1/tags/8"
          }
     }
}

Response

{
  "updated_at": "2014-04-18T20:01:13Z",
  "created_at": "2014-04-18T20:01:13Z",
  "_embedded": {
    "osdi:tag": {
      "name": "acme-team",
      "description": "Indicates a member of the acme team",
      "updated_at": "2014-04-18T19:15:31Z",
      "created_at": "2014-04-18T19:15:31Z",
      "_embedded": {
      },
      "_links": {
        "self": {
          "href": "http://api.opensupporter.org/api/v1/tags/8"
        }
      }
    }
  },
  "_links": {
    "self": {
      "href": "http://api.opensupporter.org/api/v1/taggings/5"
    },
    "osdi:tag": {
      "href": "http://api.opensupporter.org/api/v1/tags/8"
    },
    "osdi:person": {
      "href": "http://api.opensupporter.org/api/v1/people/69"
    }
  }
}

Relevant interesting implementation code (let me know if you don’t yet have access to this repo)

1.  Taggings controller
   

a. https://github.com/wufm/osdi-prototype/blob/dev_0414/app/controllers/api/v1/taggings_controller.rb#L18-L51

2.  Parsing of _links into objects/resources. (lets see just how easy/painful this is)
   

a. https://github.com/wufm/osdi-prototype/blob/dev_0414/app/services/o_util.rb#L8-L43