add docs, process PR feedback

This commit is contained in:
Art Lowel
2020-02-20 11:00:43 +01:00
parent f7f6600806
commit dea6638c1f
43 changed files with 225 additions and 91 deletions

View File

@@ -1,8 +1,23 @@
import { HALLink } from './hal-link.model';
/**
* Represents HAL resources.
*
* A HAL resource has a _links section with at least a self link.
*/
export class HALResource {
/**
* The {@link HALLink}s for this {@link HALResource}
*/
_links: {
/**
* The {@link HALLink} that refers to this {@link HALResource}
*/
self: HALLink
/**
* {@link HALLink}s to related {@link HALResource}s
*/
[k: string]: HALLink;
};
}