Merge pull request #105 from MauroDataMapper/feature/mdm-core-gh-406

Updates to path endpoints:

src/core/mdm-catalogue-item.model.ts

@@ -23,6 +23,7 @@ import {
  MdmIndexResponse,
  MdmResponse,
  Payload,
+ QueryParameters,
  Uuid
 } from '../mdm-common.model';
 
@@ -153,6 +154,17 @@ export type PathableDomainType =
  | 'versionedFolders'
  | 'versionLinks';
 
+/**
+ * Query parameters for the Path endpoints.
+ */
+export interface PathQueryParameters extends QueryParameters {
+ /**
+ * If true, only locate the latest finalised version of models, unless a specific version identitifer is
+ * used in the path.
+ */
+ finalised?: boolean;
+}
+
 export type RuleDomainType =
  | 'codeSets'
  | 'dataClasses'
@@ -200,6 +212,5 @@ export interface RuleRepresentation
 export type RuleResponse = MdmResponse<Rule>;
 export type RuleIndexResponse = MdmIndexResponse<Rule>;
 export type RuleRepresentationResponse = MdmResponse<RuleRepresentation>;
-export type RuleRepresentationIndexResponse = MdmIndexResponse<
- RuleRepresentation
->;
+export type RuleRepresentationIndexResponse =
+ MdmIndexResponse<RuleRepresentation>;

src/core/mdm-catalogue-item.resource.ts

@@ -20,6 +20,7 @@ import {
  AnnotationChildCreatePayload,
  AnnotationCreatePayload,
  PathableDomainType,
+ PathQueryParameters,
  ReferenceFile,
  ReferenceFileCreatePayload,
  RuleDomainType,
@@ -819,11 +820,17 @@ export class MdmCatalogueItemResource extends MdmResource {
  * getPath('codeSets', 'cs:My Code Set')
  * getPath('folders', 'fo:My Folder')
  * ```
+ *
+ * You can also request only latest finalised models are located too by passing the parameter:
+ *
+ * ```ts
+ * getPath('dataModels', `dm:My Data Model', { finalised: true })
+ * ```
  */
  getPath(
  domainType: PathableDomainType,
  path: string,
- query?: QueryParameters,
+ query?: PathQueryParameters,
  options?: RequestSettings
  ) {
  const encodedPath = encodeURIComponent(path);
@@ -855,7 +862,7 @@ export class MdmCatalogueItemResource extends MdmResource {
  domainType: PathableDomainType,
  id: Uuid,
  path: string,
- query?: QueryParameters,
+ query?: PathQueryParameters,
  options?: RequestSettings
  ) {
  const encodedPath = encodeURIComponent(path);

src/mdm-common.model.ts

@@ -469,6 +469,13 @@ export interface CatalogueItem {
  domainType: CatalogueItemDomainType;
 }
 
+export interface Pathable {
+ /**
+ * A read-only path generated by Mauro representing the location of this item in the catalogue.
+ */
+ path: string;
+}
+
 export interface CatalogueItemDetail extends Required<CatalogueItem> {
  [key: string]: any;
  label: string;
@@ -553,9 +560,8 @@ export interface CatalogueItemSearchResult extends CatalogueItem {
  breadcrumbs: Breadcrumb[];
 }
 
-export type CatalogueItemSearchResponse = MdmIndexResponse<
- CatalogueItemSearchResult
->;
+export type CatalogueItemSearchResponse =
+ MdmIndexResponse<CatalogueItemSearchResult>;
 
 /**
  * Set of parameters to define if an operation should be handled asynchronously.
@@ -571,4 +577,4 @@ export interface AsyncParameters {
  * other requests.
  */
  asynchronous?: boolean;
-}
+}