# apiRef

The <apiRef> element is the top-level element for generic API reference topic type.

#### Description

The <apiRef> element provides the common structure and elements for generic API reference topic types. This element requires an ID attribute as an anchor point. This ID is the target for references by <link> or <xref> elements (conref attribute), and for other internal specialization elements that refer to this <apiRef> content. Use a unique key such as fully qualified package name for the named API reference.

#### Contained by

apiRef, reference, topic

#### Contains

apiDetail, apiName, apiRef, prolog, related-links, shortdesc

#### Content model

( (apiName) then (shortdesc) then (prolog) (optional) then (apiDetail) then (related-links) (optional) then (apiRef) (any number))

#### Inheritance

topic/topic reference/reference

- apiName
  The <apiName> element provides the name of an application programming interface (API).
- apiDetail
  The <apiDetail> element provides the most general representation for reference documentation detail about an API item. This element is the main container for the detailed content.

Parent topic: apiRef module