ApiDescription (OpenAM Server Only 7.3.1 Documentation)

java.lang.Object
- org.forgerock.api.models.ApiDescription

```
public final class ApiDescription
extends Object
```
Class that represents the ApiDescription type in API descriptor.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ApiDescription.Builder
Builder for the ApiDescription.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ApiDescription.Builder`	`apiDescription()`	Create a new Builder for ApiDescription.
`boolean`	`equals(Object o)`
`Definitions`	`getDefinitions()`	Getter of definitions.
`LocalizableString`	`getDescription()`	Gets description of API Descriptor.
`Errors`	`getErrors()`	Getter of errors.
`String`	`getId()`	Getter of id.
`Paths`	`getPaths()`	Getter of paths.
`Services`	`getServices()`	Getter of services.
`String`	`getVersion()`	Getter of version.
`int`	`hashCode()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getId
```
public String getId()
```
    Getter of id.
    
    Returns:
    
    id
  - getVersion
```
public String getVersion()
```
    Getter of version.
    
    Returns:
    
    The version.
  - getDescription
```
public LocalizableString getDescription()
```
    Gets description of API Descriptor.
    
    Returns:
    
    Description of API Descriptor
  - getDefinitions
```
public Definitions getDefinitions()
```
    Getter of definitions.
    
    Returns:
    
    Definitions map
  - getServices
```
public Services getServices()
```
    Getter of services.
    
    Returns:
    
    Services map
  - getErrors
```
public Errors getErrors()
```
    Getter of errors.
    
    Returns:
    
    Errors map
  - getPaths
```
public Paths getPaths()
```
    Getter of paths.
    
    Returns:
    
    Paths
  - apiDescription
```
public static ApiDescription.Builder apiDescription()
```
    Create a new Builder for ApiDescription.
    
    Returns:
    
    Builder
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object