Skip to content

Commit

Permalink
Add a comment
Browse files Browse the repository at this point in the history
  • Loading branch information
lyonsil committed Sep 25, 2023
1 parent 2e5ef08 commit 4ac4946
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions src/shared/models/project-data-provider.model.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,17 @@ import type { DataProviderDataType } from 'shared/models/data-provider.model';

/** Indicates to a PDP what extension data is being referenced */
export type ExtensionDataScope = {
/** Name of an extension as provided in its manifest */
extensionName: string;
/** Name of a unique partition or segment of data within the extension
* Some examples include (but are not limited to):
* - name of an important data structure that is maintained in a project
* - name of a downloaded data set that is being cached
* - name of a resource created by a user that should be maintained in a project
*
* This is the smallest level of granularity provided by a PDP for accessing extension data.
* There is no way to get or set just a portion of data identified by a single dataQualifier value.
* */
dataQualifier: string;
};

Expand Down

0 comments on commit 4ac4946

Please sign in to comment.