Heracles.ts

@hydra-cg/heracles.ts > IApiDocumentation

Interface: IApiDocumentation

Represents an abstract API documentation.

interface:

Hierarchy

IResource

↳ IApiDocumentation

Index

Properties

• description
• entryPoint
• iri
• supportedClasses
• title
• type

Methods

• getEntryPoint

---

Properties

<Optional> description

● description: string

Defined in DataModel/IApiDocumentation.ts:23

Gets a description of this API documentation.

readonly:

returns:

---

entryPoint

● entryPoint: string

Defined in DataModel/IApiDocumentation.ts:37

Gets the Url of the entry point of the API.

readonly:

returns:

---

iri

● iri: string

Inherited from IResource.iri

Defined in DataModel/IResource.ts:13

Gets an Iri of a resource.

readonly:

returns:

---

supportedClasses

● supportedClasses: ResourceFilterableCollection<IClass>

Defined in DataModel/IApiDocumentation.ts:30

Gets the supported classes by this API.

readonly:

returns:

---

<Optional> title

● title: string

Defined in DataModel/IApiDocumentation.ts:16

Gets a title of this API documentation.

readonly:

returns:

---

type

● type: TypesCollection

Inherited from IResource.type

Defined in DataModel/IResource.ts:20

Gets classes a given resource is of.

readonly:

returns:

---

Methods

getEntryPoint

▸ getEntryPoint(): Promise<IWebResource>

Defined in DataModel/IApiDocumentation.ts:44

Retrieves an API’s entry point resource.

readonly:

Returns: Promise<IWebResource>

---

This site is open source. Improve this page.