Jump to: navigation, search

Difference between revisions of "API Special Interest Group/Current Design/Links"

(→‎Examples)
Line 13: Line 13:
 
[http://json-schema.org/latest/json-schema-hypermedia.html JSON Hyper-Schema]
 
[http://json-schema.org/latest/json-schema-hypermedia.html JSON Hyper-Schema]
 
</ref>
 
</ref>
−
for all embedded link references.
+
style for all embedded link references.
  
 
=== Examples ===
 
=== Examples ===
Line 80: Line 80:
 
             ],
 
             ],
 
             "name": "vol-003"
 
             "name": "vol-003"
 +
        }
 +
    ]
 +
}
 +
</nowiki></pre>
 +
 +
== Keystone ==
 +
 +
[http://developer.openstack.org/api-ref-identity-v3.html Keystone API reference]
 +
 +
Keystone is using the JSON Hyper-Schema <ref name="json-hyper-schema" /> style reference for some links that it returns.
 +
 +
There are some requests and responses that use the keyword '''"self"''' when referring to resource links, these appear within a '''"links"''' dictionary that looks similar to the JSON Hyper-Schema style. These '''"links"''' dictionaries may also contain '''"next"''' and '''"previous"''' links.
 +
 +
There are also some responses which use the '''"self"''' keyword and the '''"url"''' keyword. The '''"url"''' key appears to occur in requests as well as responses.
 +
 +
The majority of calls appear to use the '''"self"''' keyword wrapped in the '''"links"''' dictionary, as follows:
 +
 +
<pre><nowiki>
 +
{
 +
    "links": {
 +
        "self": "http://spam:eggs/bacon"
 +
    }
 +
}
 +
</nowiki></pre>
 +
 +
=== Examples ===
 +
 +
<pre><nowiki>GET /v3</nowiki></pre>
 +
 +
<pre><nowiki>
 +
{
 +
    "version": {
 +
        "id": "v3.4",
 +
        "links": [
 +
            {
 +
                "href": "http://localhost:35357/v3/",
 +
                "rel": "self"
 +
            }
 +
        ],
 +
        "media-types": [
 +
            {
 +
                "base": "application/json",
 +
                "type": "application/vnd.openstack.identity-v3+json"
 +
            }
 +
        ],
 +
        "status": "stable",
 +
        "updated": "2015-03-30T00:00:00Z"
 +
    }
 +
}
 +
</nowiki></pre>
 +
 +
<pre><nowiki>GET /v3/auth/tokens</nowiki></pre>
 +
 +
<pre><nowiki>
 +
{
 +
    "token": {
 +
        "expires_at": "2013-02-27T18:30:59.999999Z",
 +
        "issued_at": "2013-02-27T16:30:59.999999Z",
 +
        "methods": [
 +
            "password"
 +
        ],
 +
        "user": {
 +
            "domain": {
 +
                "id": "1789d1",
 +
                "links": {
 +
                    "self": "http://identity:35357/v3/domains/1789d1"
 +
                },
 +
                "name": "example.com"
 +
            },
 +
            "id": "0ca8f6",
 +
            "links": {
 +
                "self": "http://identity:35357/v3/users/0ca8f6"
 +
            },
 +
            "name": "Joe"
 +
        }
 +
    }
 +
}
 +
</nowiki></pre>
 +
 +
<pre><nowiki>POST /v3/services
 +
 +
{
 +
    "service": {
 +
        "type": "volume"
 +
    }
 +
}
 +
</nowiki></pre>
 +
 +
<pre><nowiki>
 +
{
 +
    "service": {
 +
        "enabled": true,
 +
        "id": "686766",
 +
        "links": {
 +
            "self": "http://identity:5000/v3/services/686766"
 +
        },
 +
        "type": "volume"
 +
    }
 +
}
 +
</nowiki></pre>
 +
 +
<pre><nowiki>POST /v3/endpoints
 +
 +
{
 +
    "endpoint": {
 +
        "interface": "public",
 +
        "name": "name",
 +
        "region_id": "north",
 +
        "url": "http://identity:35357/v3/endpoints/828384",
 +
        "service_id": "686766"
 +
    }
 +
}
 +
</nowiki></pre>
 +
 +
<pre><nowiki>
 +
{
 +
    "endpoint": {
 +
        "id": "828384",
 +
        "interface": "internal",
 +
        "links": {
 +
            "self": "http://identity:35357/v3/endpoints/828384"
 +
        },
 +
        "name": "the internal volume endpoint",
 +
        "region_id": "north",
 +
        "service_id": "686766",
 +
        "url": "http://identity:35357/v3/endpoints/828384"
 +
    }
 +
}
 +
</nowiki></pre>
 +
 +
<pre><nowiki>GET /v3/services</nowiki></pre>
 +
 +
<pre><nowiki>
 +
{
 +
    "links": {
 +
        "next": null,
 +
        "previous": null,
 +
        "self": "http://identity:5000/v3/services"
 +
    },
 +
    "services": [
 +
        {
 +
            "description": "Keystone Identity Service",
 +
            "enabled": true,
 +
            "id": "686766",
 +
            "links": {
 +
                "self": "http://identity:5000/v3/services/686766"
 +
            },
 +
            "name": "keystone",
 +
            "type": "identity"
 +
        },
 +
        {
 +
            "enabled": true,
 +
            "id": "936521",
 +
            "links": {
 +
                "self": "http://identity:5000/v3/services/936521"
 +
            },
 +
            "type": "volume"
 
         }
 
         }
 
     ]
 
     ]
Line 91: Line 248:
 
Nova appears to use  the JSON Hyper-Schema <ref name="json-hyper-schema" /> for most returned responses.
 
Nova appears to use  the JSON Hyper-Schema <ref name="json-hyper-schema" /> for most returned responses.
  
−
There are a few responses that use the '''url''' key to describe a link, it is not clear if these are only for external resources.
+
There are a few responses that use the '''"url"''' key to describe a link, it is not clear if these are only for external resources.
  
−
There are also a few calls which allow the values '''imageRef''' and '''flavorRef''' to accept incoming links.
+
There are also a few calls which allow the values '''"imageRef"''' and '''"flavorRef"''' to accept incoming links.
  
 
=== Examples ===
 
=== Examples ===

Revision as of 19:54, 13 October 2015

Analysis

How are links being referenced in OpenStack APIs

Current Design

Cinder

Cinder API reference

Cinder appears to use the JSON Hyper-Schema [1] style for all embedded link references.

Examples

GET /
{
    "versions": [
        {
            "status": "CURRENT",
            "updated": "2012-01-04T11:33:21Z",
            "id": "v1.0",
            "links": [
                {
                    "href": "http://23.253.228.211:8776/v1/",
                    "rel": "self"
                }
            ]
        },
        {
            "status": "CURRENT",
            "updated": "2012-11-21T11:33:21Z",
            "id": "v2.0",
            "links": [
                {
                    "href": "http://23.253.228.211:8776/v2/",
                    "rel": "self"
                }
            ]
        }
    ]
}

GET /v2/{tenant_id}/volumes
{
    "volumes": [
        {
            "id": "45baf976-c20a-4894-a7c3-c94b7376bf55",
            "links": [
                {
                    "href": "http://localhost:8776/v2/0c2eba2c5af04d3f9e9d0d410b371fde/volumes/45baf976-c20a-4894-a7c3-c94b7376bf55",
                    "rel": "self"
                },
                {
                    "href": "http://localhost:8776/0c2eba2c5af04d3f9e9d0d410b371fde/volumes/45baf976-c20a-4894-a7c3-c94b7376bf55",
                    "rel": "bookmark"
                }
            ],
            "name": "vol-004"
        },
        {
            "id": "5aa119a8-d25b-45a7-8d1b-88e127885635",
            "links": [
                {
                    "href": "http://localhost:8776/v2/0c2eba2c5af04d3f9e9d0d410b371fde/volumes/5aa119a8-d25b-45a7-8d1b-88e127885635",
                    "rel": "self"
                },
                {
                    "href": "http://localhost:8776/0c2eba2c5af04d3f9e9d0d410b371fde/volumes/5aa119a8-d25b-45a7-8d1b-88e127885635",
                    "rel": "bookmark"
                }
            ],
            "name": "vol-003"
        }
    ]
}

Keystone

Keystone API reference

Keystone is using the JSON Hyper-Schema [1] style reference for some links that it returns.

There are some requests and responses that use the keyword "self" when referring to resource links, these appear within a "links" dictionary that looks similar to the JSON Hyper-Schema style. These "links" dictionaries may also contain "next" and "previous" links.

There are also some responses which use the "self" keyword and the "url" keyword. The "url" key appears to occur in requests as well as responses.

The majority of calls appear to use the "self" keyword wrapped in the "links" dictionary, as follows: 

{
    "links": {
        "self": "http://spam:eggs/bacon"
    }
}

Examples

GET /v3
{
    "version": {
        "id": "v3.4",
        "links": [
            {
                "href": "http://localhost:35357/v3/",
                "rel": "self"
            }
        ],
        "media-types": [
            {
                "base": "application/json",
                "type": "application/vnd.openstack.identity-v3+json"
            }
        ],
        "status": "stable",
        "updated": "2015-03-30T00:00:00Z"
    }
}

GET /v3/auth/tokens
{
    "token": {
        "expires_at": "2013-02-27T18:30:59.999999Z",
        "issued_at": "2013-02-27T16:30:59.999999Z",
        "methods": [
            "password"
        ],
        "user": {
            "domain": {
                "id": "1789d1",
                "links": {
                    "self": "http://identity:35357/v3/domains/1789d1"
                },
                "name": "example.com"
            },
            "id": "0ca8f6",
            "links": {
                "self": "http://identity:35357/v3/users/0ca8f6"
            },
            "name": "Joe"
        }
    }
}

POST /v3/services

{
    "service": {
        "type": "volume"
    }
}

{
    "service": {
        "enabled": true,
        "id": "686766",
        "links": {
            "self": "http://identity:5000/v3/services/686766"
        },
        "type": "volume"
    }
}

POST /v3/endpoints

{
    "endpoint": {
        "interface": "public",
        "name": "name",
        "region_id": "north",
        "url": "http://identity:35357/v3/endpoints/828384",
        "service_id": "686766"
    }
}

{
    "endpoint": {
        "id": "828384",
        "interface": "internal",
        "links": {
            "self": "http://identity:35357/v3/endpoints/828384"
        },
        "name": "the internal volume endpoint",
        "region_id": "north",
        "service_id": "686766",
        "url": "http://identity:35357/v3/endpoints/828384"
    }
}

GET /v3/services
{
    "links": {
        "next": null,
        "previous": null,
        "self": "http://identity:5000/v3/services"
    },
    "services": [
        {
            "description": "Keystone Identity Service",
            "enabled": true,
            "id": "686766",
            "links": {
                "self": "http://identity:5000/v3/services/686766"
            },
            "name": "keystone",
            "type": "identity"
        },
        {
            "enabled": true,
            "id": "936521",
            "links": {
                "self": "http://identity:5000/v3/services/936521"
            },
            "type": "volume"
        }
    ]
}

Nova

Nova API reference

Nova appears to use the JSON Hyper-Schema [1] for most returned responses.

There are a few responses that use the "url" key to describe a link, it is not clear if these are only for external resources.

There are also a few calls which allow the values "imageRef" and "flavorRef" to accept incoming links.

Examples

GET /
{
    "versions": [
        {
            "id": "v2.0",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/",
                    "rel": "self"
                }
            ],
            "status": "SUPPORTED",
            "version": "",
            "min_version": "",
            "updated": "2011-01-21T11:33:21Z"
        },
        {
            "id": "v2.1",
            "links": [
                {
                    "href": "http://openstack.example.com/v2.1/",
                    "rel": "self"
                }
            ],
            "status": "CURRENT",
            "version": "2.3",
            "min_version": "2.1",
            "updated": "2013-07-23T11:33:21Z"
        }
    ]
}

POST /v2.1/​{tenant_id}​/os-agents

{
    "agent": {
        "hypervisor": "hypervisor",
        "os": "os",
        "architecture": "x86",
        "version": "8.0",
        "md5hash": "add6bb58e139be103324d04d82d8f545",
        "url": "http://example.com/path/to/resource"
    }
}

{
    "agent": {
        "agent_id": 1,
        "architecture": "x86",
        "hypervisor": "hypervisor",
        "md5hash": "add6bb58e139be103324d04d82d8f545",
        "os": "os",
        "url": "http://example.com/path/to/resource",
        "version": "8.0"
    }
}

POST /v2.1/{tenant_id}/servers

{
    "server": {
        "name": "new-server-test",
        "imageRef": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
        "flavorRef": "http://openstack.example.com/openstack/flavors/1",
        "metadata": {
            "My Server Name": "Apache1"
        },
        "min_count": "2",
        "max_count": "3"
    }
}

{
    "server": {
        "adminPass": "wfksH3GTTseP",
        "id": "440cf918-3ee0-4143-b289-f63e1d2000e6",
        "links": [
            {
                "href": "http://openstack.example.com/v2.1/servers/440cf918-3ee0-4143-b289-f63e1d2000e6",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/servers/440cf918-3ee0-4143-b289-f63e1d2000e6",
                "rel": "bookmark"
            }
        ]
    }
}

References

  1. ↑ 1.0 1.1 1.2 JSON Hyper-Schema
Retrieved from "https://wiki.openstack.org/w/index.php?title=API_Special_Interest_Group/Current_Design/Links&oldid=92442"