Sha256: 273e4f5ae0e7527a8eada3e41e9a9dc9985aeb4af50ad22e2021dbacfa031fe4

Contents?: true

Size: 1.76 KB

Versions: 8

Compression:

Stored size: 1.76 KB

Contents

{ "type":"object",
  "title": "tag",
  "description":"A tag",
  "properties": {
    "id": {
      "description": "uuid of the object.",
      "identity":true,
      "readonly":true,
      "type":"string"
    },
    "name": {
      "description": "The tag itself",
      "readonly":true,
      "type":"string"
    },    
    "taggings_count": {
      "description": "Usage count of this tag, for all objects in whole company scope.",
      "readonly":true,
      "type":"number"
    }    
  },
  "links":[
    { "rel": "self",
      "href": "tags/{id}"
    },
    { "rel": "instances",
      "href": "tags",
      "properties" : {
        "page":{
          "title" : "Page",
          "description": "In paginated results set the page to look for",
          "type":"number"
        },
        "per_page":{
          "title" : "Per page",
          "description": "Results per page. Default is 10, max is 100",
          "type":"number"
        },
        "filter[q]":{
          "title" : "Search",
          "description": "Search in name",
          "type":"string"
        },
        "filter[related_object_type]":{
          "title" : "Related object type",
          "description": "Filter tags by their related object base type",
          "type":"string"
        },
        "sort_by":{
          "title" : "Sort by",
          "description": "Sort the results by the given field",
          "enum":["filename","taggings_count"],
          "type": "string"
        },
        "sort":{
          "title" : "Sort",
          "enum":["ASC","DESC"],
          "description": "Sort the results in ASC or DESC"
        }
      }
    },
    { "rel": "destroy",
      "href": "tags/{id}",
      "method": "DELETE"
    },
    { "rel": "update",
      "href": "tags/{id}",
      "method": "PUT"
    }
  ]
}

Version data entries

8 entries across 8 versions & 1 rubygems

Version Path
sk_api_schema-0.3.4 json/v1.0/tag.json
sk_api_schema-0.3.3 json/v1.0/tag.json
sk_api_schema-0.3.2 json/v1.0/tag.json
sk_api_schema-0.3.1 json/v1.0/tag.json
sk_api_schema-0.3.0 json/v1.0/tag.json
sk_api_schema-0.2.6 json/v1.0/tag.json
sk_api_schema-0.2.5 json/v1.0/tag.json
sk_api_schema-0.2.4 json/v1.0/tag.json