com.netflix.genie.web.controllers

Class RootRestController

java.lang.Object

com.netflix.genie.web.controllers.RootRestController

@RestController
 @RequestMapping(value="/api/v3")
public class RootRestController
extends java.lang.Object

Rest controller for the V3 API root.

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
RootRestController(RootResourceAssembler rootResourceAssembler) Constructor.

Method Summary

Modifier and Type	Method and Description
RootResource	getRoot() Get a simple HAL+JSON object which represents the various links available in Genie REST API as an entry point.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RootRestController

@Autowired
public RootRestController(RootResourceAssembler rootResourceAssembler)

Constructor.

Parameters:

rootResourceAssembler - The assembler to use to construct resources.

Method Detail

getRoot

@RequestMapping(method=GET,
                produces="application/hal+json")
 @ResponseStatus(value=OK)
public RootResource getRoot()

Get a simple HAL+JSON object which represents the various links available in Genie REST API as an entry point.

Returns:

the root resource containing various links to the real APIs