Search
  • Software
    • Overview
    • OpenStack Components
    • SDKs
    • Deployment Tools
    • OpenStack Map
    • Sample Configs
  • Use Cases
    • Users in Production
    • Ironic Bare Metal
    • Edge Computing
    • Telecom & NFV
    • Science and HPC
    • Containers
    • Enterprise
    • User Survey
  • Events
    • Open Infrastructure Summits
    • Project Teams Gathering
    • OpenDev
    • Community Events
    • OpenStack & OpenInfra Days
    • Summit Videos
  • Community
    • Welcome! Start Here
    • OpenStack Technical Committee
    • Speakers Bureau
    • OpenStack Wiki
    • Get Certified (COA)
    • Jobs
    • Marketing Resources
    • Community News
    • Superuser Magazine
    • OpenInfra Foundation Supporting Organizations
    • Open Infrastructure Foundation (OpenInfra Foundation)
  • Marketplace
    • Training
    • Distros & Appliances
    • Public Clouds
    • Hosted Private Clouds
    • Remotely Managed Private Clouds
    • Consulting & Integrators
    • Drivers
  • Blog
  • Docs
  • Join
    • Sign up for Foundation Membership
    • Sponsor the Foundation
    • More about the Foundation
  • Log In

Links

Links¶

Links to other resources often need to be represented in responses. There is already a well established format for this representation in JSON Hyper-Schema: Hypertext definitions for JSON Schema. This is already the prevailing representation in use by a number of prominent OpenStack projects and also in use by the Errors guideline.

Note

Before inventing a new value for rel, please check the existing Link Relations for something you can reuse.

Links Example¶

{
  "links": [
    {
      "rel": "help",
      "href": "http://developer.openstack.org/api-ref/compute/#create-server"
    }
  ]
}
this page last updated: 2016-08-11 12:12:27
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

  • Guides
  • Install Guides
  • User Guides
  • Configuration Guides
  • Operations and Administration Guides
  • API Guides
  • Contributor Guides
  • Languages
  • Deutsch (German)
  • Français (French)
  • Bahasa Indonesia (Indonesian)
  • Italiano (Italian)
  • 日本語 (Japanese)
  • 한국어 (Korean)
  • Português (Portuguese)
  • Türkçe (Türkiye)
  • 简体中文 (Simplified Chinese)

API Special Interest Group 0.0.1.dev301

  • Process for adding or changing guidelines
  • Example Guideline Category
  • Cross-Project Liaisons
  • Guided Review Process
  • API Documentation
  • Ensuring API Interoperability
  • Compatibility
  • Consuming Service Catalog
  • Counting Resources
  • API Discoverability
  • DNS-based Service Discovery
  • Errors
  • ETags
  • Evaluating API Changes
  • API Extensions
  • General
  • HTTP Header Guidelines
  • HTTP Guidelines
  • Links
    • Links Example
  • Metadata
  • Microversion Specification
  • Naming Conventions
  • Pagination, Filtering, and Sorting
  • Representation Structure Conventions
  • Exposing microversions in SDKs
  • Tags
  • Terms
  • Testing
  • Date and Time Conventions
  • Effective URIs

Page Contents

  • Links
    • Links Example

OpenStack

  • Projects
  • OpenStack Security
  • Common Questions
  • Blog
  • g
  • News

Community

  • User Groups
  • Events
  • Jobs
  • Companies
  • Contribute

Documentation

  • OpenStack Manuals
  • Getting Started
  • API Documentation
  • Wiki

Branding & Legal

  • Logos & Guidelines
  • Trademark Policy
  • Privacy Policy
  • OpenStack CLA

Stay In Touch

The OpenStack project is provided under the Apache 2.0 license. Openstack.org is powered by Rackspace Cloud Computing.