@twin.org/federated-catalogue-models 0.0.1-next.10

package/dist/types/models/data-space-connector/IDataSpaceConnector.d.ts

@@ -0,0 +1,77 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { GaiaXContextType, GaiaXTypes, IDataExchangeComponent, IDataResource, IEndpoint } from "@twin.org/standards-gaia-x";
+import type { FederatedCatalogueTypes } from "../federatedCatalogueTypes";
+/**
+ * TWIN Data Space Connector.
+ */
+export interface IDataSpaceConnector extends IDataExchangeComponent {
+    /**
+     * The LD Context.
+     */
+    "@context": GaiaXContextType;
+    /**
+     * A unique identifier given to this Data Space Connector.
+     */
+    id: string;
+    /**
+     * A Connector is a Data Exchange Component
+     */
+    type: [
+        typeof GaiaXTypes.DataExchangeComponent,
+        typeof FederatedCatalogueTypes.DataSpaceConnector,
+        ...string[]
+    ];
+    /**
+     * Connector's Identity that allows to know public key of this Connector.
+     */
+    identity: string;
+    /**
+     * Who maintains this Data Space Connector.
+     */
+    maintainer: string;
+    /**
+     * The name of this Data Space Connector
+     */
+    name?: string;
+    /**
+     * A description of this Data Space Connector
+     */
+    description?: string;
+    /**
+     * The default endpoint of the Connector.
+     * This endpoint can be used as a base to guess other endpoints in case they are not explicitly declared.
+     */
+    defaultEndpoint: IEndpoint;
+    /**
+     * The endpoint used for data subscription by Consumers.
+     * If the endpoint URL is a relative reference to a URL then it should be resolved using the
+     * default endpoint URL as a base URL.
+     */
+    subscriptionActivityEndpoint?: IEndpoint;
+    /**
+     * The endpoint used by Providers to push data.
+     * If the endpoint URL is a relative reference to a URL then it should be resolved using the
+     * default endpoint URL as a base URL.
+     */
+    pushActivityEndpoint: IEndpoint;
+    /**
+     * The endpoint used by Consumers to pull data from.
+     * If the endpoint URL is a relative reference to a URL then it should be resolved using the
+     * default endpoint URL as a base URL.
+     */
+    pullDataEndpoint: IEndpoint;
+    /**
+     * The resources offered by this Connector.
+     * A resource index is usually a relative reference to the default endpoint base URL.
+     * Nonetheless if the resource already declares an endpoint URL that one should be taken.
+     * It is captured the case where the Data Resource is supplied
+     * via a list of identifiers or through a map indexed by Id
+     *
+     */
+    offeredResource: string[] | {
+        [resourceId: string]: IDataResource | (IJsonLdNodeObject & {
+            id: string;
+            type: typeof GaiaXTypes.DataResource;
+        });
+    };
+}

package/dist/types/models/data-space-connector/IDataSpaceConnectorCredential.d.ts

@@ -0,0 +1,11 @@
+import type { IDataSpaceConnector } from "./IDataSpaceConnector";
+import type { ICredential } from "../ICredential";
+/**
+ * Participant Credential.
+ */
+export interface IDataSpaceConnectorCredential extends ICredential {
+    /**
+     * The Credential Subject
+     */
+    credentialSubject: IDataSpaceConnector;
+}

package/dist/types/models/data-space-connector/IDataSpaceConnectorEntry.d.ts

@@ -0,0 +1,18 @@
+import type { ICatalogueBase } from "../ICatalogueBase";
+import type { IDataSpaceConnector } from "./IDataSpaceConnector";
+import type { FederatedCatalogueContextType } from "../federatedCatalogueContextType";
+/**
+ * Interface describing a participant.
+ */
+export interface IDataSpaceConnectorEntry extends IDataSpaceConnector, ICatalogueBase {
+    /**
+     * The LD Context
+     */
+    "@context": FederatedCatalogueContextType;
+    /**
+     * Offered resources. Probably in the future this wll be separated in a different entry so
+     * that a  Data Space Connector entry does not need to be modified when a new Data Resource
+     * is offered.
+     */
+    offeredResource: string[];
+}

package/dist/types/models/data-space-connector/IDataSpaceConnectorList.d.ts

@@ -0,0 +1,25 @@
+import type { SchemaOrgTypes } from "@twin.org/standards-schema-org";
+import type { IDataSpaceConnectorEntry } from "./IDataSpaceConnectorEntry";
+import type { FederatedCatalogueContextType } from "../federatedCatalogueContextType";
+/**
+ * Interface describing a list of Data Space Connectors.
+ */
+export interface IDataSpaceConnectorList {
+    /**
+     * The LD Context.
+     */
+    "@context": FederatedCatalogueContextType;
+    /**
+     * The type
+     */
+    type: typeof SchemaOrgTypes.ItemList;
+    /**
+     * The components of the Collection
+     *
+     */
+    [SchemaOrgTypes.ItemListElement]: Omit<IDataSpaceConnectorEntry, "@context">[];
+    /**
+     * Next item cursor.
+     */
+    [SchemaOrgTypes.NextItem]?: string;
+}

package/dist/types/models/federatedCatalogueContextInstances.d.ts

@@ -0,0 +1,14 @@
+import type { FederatedCatalogueContextType } from "./federatedCatalogueContextType";
+/**
+ * The LD context instances concerning the Federated Catalogue.
+ */
+export declare abstract class FederatedCatalogueContextInstances {
+    /**
+     * The LD Context of a list of Catalogue entries.
+     */
+    static DEFAULT_LD_CONTEXT_ENTRY_LIST: FederatedCatalogueContextType;
+    /**
+     * The LD Context of a Catalogue entry.
+     */
+    static DEFAULT_LD_CONTEXT_ENTRY: FederatedCatalogueContextType;
+}

package/dist/types/models/federatedCatalogueContextType.d.ts

@@ -0,0 +1,11 @@
+import type { GaiaXContexts } from "@twin.org/standards-gaia-x";
+import type { SchemaOrgContexts } from "@twin.org/standards-schema-org";
+import type { FederatedCatalogueContexts } from "./federatedCatalogueContexts";
+/**
+ * Type that defines the LD Context for the Federated Catalogue entities and entries.
+ */
+export type FederatedCatalogueContextType = [
+    typeof SchemaOrgContexts.ContextRoot,
+    typeof GaiaXContexts.ContextRoot,
+    typeof FederatedCatalogueContexts.ContextRoot
+];

package/dist/types/models/federatedCatalogueContexts.d.ts

@@ -0,0 +1,13 @@
+/**
+ * The LD context concerning the Federated Catalogue.
+ */
+export declare const FederatedCatalogueContexts: {
+    /**
+     * The context root for the federated catalogue types.
+     */
+    readonly ContextRoot: "https://schema.twindev.org/federated-catalogue/";
+};
+/**
+ * The Exported types
+ */
+export type FederatedCatalogueContexts = (typeof FederatedCatalogueContexts)[keyof typeof FederatedCatalogueContexts];

package/dist/types/models/federatedCatalogueEntryType.d.ts

@@ -0,0 +1,7 @@
+import type { GaiaXTypes } from "@twin.org/standards-gaia-x";
+import type { FederatedCatalogueTypes } from "./federatedCatalogueTypes";
+/**
+ * Types of entries in the Federated Catalogue
+ *
+ */
+export type FederatedCatalogueEntryType = typeof GaiaXTypes.Participant | typeof GaiaXTypes.DataExchangeComponent | typeof GaiaXTypes.DataResource | typeof GaiaXTypes.ServiceOffering | typeof FederatedCatalogueTypes.DataSpaceConnector;

package/dist/types/models/federatedCatalogueTypes.d.ts

@@ -0,0 +1,53 @@
+/**
+ * The types concerning the Federated Catalogue.
+ */
+export declare const FederatedCatalogueTypes: {
+    /**
+     * A Credential that is compliant.
+     */
+    readonly CompliantCredential: "CompliantCredential";
+    /**
+     * A Compliance Credential.
+     */
+    readonly ComplianceCredential: "ComplianceCredential";
+    /**
+     * A Data Space Connector.
+     */
+    readonly DataSpaceConnector: "DataSpaceConnector";
+    /**
+     * A Data Resource Entry.
+     */
+    readonly DataResourceEntry: "DataResourceEntry";
+    /**
+     * A Data Space Connector List.
+     */
+    readonly DataResourceList: "DataResourceList";
+    /**
+     * A Data Space Connector Entry.
+     */
+    readonly DataSpaceConnectorEntry: "DataSpaceConnectorEntry";
+    /**
+     * A Data Space Connector List.
+     */
+    readonly DataSpaceConnectorList: "DataSpaceConnectorList";
+    /**
+     * A Participant Entry.
+     */
+    readonly ParticipantEntry: "ParticipantEntry";
+    /**
+     * A Participant List.
+     */
+    readonly ParticipantList: "ParticipantList";
+    /**
+     * A Service Offering Entry.
+     */
+    readonly ServiceOfferingEntry: "ServiceOfferingEntry";
+    /**
+     * A Service Offering List.
+     */
+    readonly ServiceOfferingList: "ServiceOfferingList";
+};
+/**
+ * The Exported types
+ */
+export type FederatedCatalogueTypes = (typeof FederatedCatalogueTypes)[keyof typeof FederatedCatalogueTypes];

package/dist/types/models/participant/IParticipantCredential.d.ts

@@ -0,0 +1,11 @@
+import type { IParticipant } from "@twin.org/standards-gaia-x";
+import type { ICredential } from "../ICredential";
+/**
+ * Participant Credential.
+ */
+export interface IParticipantCredential extends ICredential {
+    /**
+     * The Credential Subject
+     */
+    credentialSubject: IParticipant;
+}

package/dist/types/models/participant/IParticipantEntry.d.ts

@@ -0,0 +1,12 @@
+import type { IParticipant } from "@twin.org/standards-gaia-x";
+import type { FederatedCatalogueContextType } from "../federatedCatalogueContextType";
+import type { ICatalogueBase } from "../ICatalogueBase";
+/**
+ * Interface describing a participant.
+ */
+export interface IParticipantEntry extends IParticipant, ICatalogueBase {
+    /**
+     * The LD Context
+     */
+    "@context": FederatedCatalogueContextType;
+}

package/dist/types/models/participant/IParticipantList.d.ts

@@ -0,0 +1,25 @@
+import type { SchemaOrgTypes } from "@twin.org/standards-schema-org";
+import type { IParticipantEntry } from "./IParticipantEntry";
+import type { FederatedCatalogueContextType } from "../federatedCatalogueContextType";
+/**
+ * Interface describing a participant entry list.
+ */
+export interface IParticipantList {
+    /**
+     * The LD Context.
+     */
+    "@context": FederatedCatalogueContextType;
+    /**
+     * The type
+     */
+    type: typeof SchemaOrgTypes.ItemList;
+    /**
+     * The components of the Collection
+     *
+     */
+    [SchemaOrgTypes.ItemListElement]: Omit<IParticipantEntry, "@context">[];
+    /**
+     * Next item cursor.
+     */
+    [SchemaOrgTypes.NextItem]?: string;
+}

package/dist/types/models/service-offering/IServiceOfferingCredential.d.ts

@@ -0,0 +1,11 @@
+import type { IServiceOffering } from "@twin.org/standards-gaia-x";
+import type { ICredential } from "../ICredential";
+/**
+ * A Service Offering Credential
+ */
+export interface IServiceOfferingCredential extends ICredential {
+    /**
+     * The Credential Subject
+     */
+    credentialSubject: IServiceOffering;
+}

package/dist/types/models/service-offering/IServiceOfferingEntry.d.ts

@@ -0,0 +1,25 @@
+import type { IServiceOffering } from "@twin.org/standards-gaia-x";
+import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
+import type { FederatedCatalogueContextType } from "../federatedCatalogueContextType";
+import type { ICatalogueBase } from "../ICatalogueBase";
+/**
+ * Interface describing a Service Offering.
+ */
+export interface IServiceOfferingEntry extends ICatalogueBase, IServiceOffering {
+    /**
+     * The LD Context
+     */
+    "@context": FederatedCatalogueContextType;
+    /**
+     * Overwrites providedBy as we only store identifier as string
+     */
+    providedBy: string;
+    /**
+     * Overwrites aggregationOfResources as we only store identifier as string
+     */
+    aggregationOfResources?: string[];
+    /**
+     * The service policy is always stored as an array
+     */
+    servicePolicy: IOdrlPolicy[];
+}

package/dist/types/models/service-offering/IServiceOfferingList.d.ts

@@ -0,0 +1,25 @@
+import type { SchemaOrgTypes } from "@twin.org/standards-schema-org";
+import type { IServiceOfferingEntry } from "./IServiceOfferingEntry";
+import type { FederatedCatalogueContextType } from "../federatedCatalogueContextType";
+/**
+ * Interface describing a list of Service Offering Entries.
+ */
+export interface IServiceOfferingList {
+    /**
+     * The LD Context.
+     */
+    "@context": FederatedCatalogueContextType;
+    /**
+     * The type
+     */
+    type: typeof SchemaOrgTypes.ItemList;
+    /**
+     * The components of the Collection
+     *
+     */
+    [SchemaOrgTypes.ItemListElement]: Omit<IServiceOfferingEntry, "@context">[];
+    /**
+     * Next item cursor.
+     */
+    [SchemaOrgTypes.NextItem]?: string;
+}

package/dist/types/models/verificationFailureReasons.d.ts

@@ -0,0 +1,53 @@
+/**
+ * The verification failure reasons.
+ */
+export declare const VerificationFailureReasons: {
+    /**
+     * Credential type is invalid.
+     */
+    readonly InvalidCredentialType: "invalidCredentialType";
+    /**
+     * The issuer is invalid.
+     */
+    readonly InvalidIssuer: "invalidIssuer";
+    /**
+     * Credential is not valid yet.
+     */
+    readonly NotValidYet: "notValidYet";
+    /**
+     * Credential ahs expired.
+     */
+    readonly Expired: "expired";
+    /**
+     * Credential's evidence cannot be verified.
+     */
+    readonly EvidenceCannotBeVerified: "evidenceCannotBeVerified";
+    /**
+     * Credential has no expiration.
+     */
+    readonly NoValidityEndPeriod: "noValidityEndPeriod";
+    /**
+     * Credential's subject is missing.
+     */
+    readonly MissingSubject: "missingSubject";
+    /**
+     * Credential's evidences are missing.
+     */
+    readonly MissingEvidences: "missingEvidences";
+    /**
+     * General error happened while verifying and the credential cannot be deemed as verified.
+     */
+    readonly GeneralVerificationError: "generalVerificationError";
+    /**
+     * Credential's integrity check has failed
+     */
+    readonly IntegrityCheckFailed: "integrityCheckFailed";
+    /**
+     * Credential's Evidence cannot be retrieved.
+     */
+    readonly EvidenceCannotBeRetrieved: "evidenceCannotBeRetrieved";
+};
+/**
+ * The verification failure Reasons.
+ */
+export type VerificationFailureReasons = (typeof VerificationFailureReasons)[keyof typeof VerificationFailureReasons];

package/docs/changelog.md

@@ -0,0 +1,73 @@
+# @twin.org/federated-catalogue-models - Changelog
+
+## [0.0.1-next.10](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.1-next.9...federated-catalogue-models-v0.0.1-next.10) (2025-06-18)
+
+
+### Features
+
+* update schemas ([58d8581](https://github.com/twinfoundation/federated-catalogue/commit/58d85813231f6576490937d4394e7be0f6d8c58d))
+
+## [0.0.1-next.9](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.1-next.8...federated-catalogue-models-v0.0.1-next.9) (2025-06-12)
+
+
+### Features
+
+* update dependencies ([24ff3d7](https://github.com/twinfoundation/federated-catalogue/commit/24ff3d772cf7bd7f60547c5b314355e75ba55424))
+
+## [0.0.1-next.8](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.1-next.7...federated-catalogue-models-v0.0.1-next.8) (2025-06-03)
+
+
+### Features
+
+* update ts-to-schema generation ([41bdde7](https://github.com/twinfoundation/federated-catalogue/commit/41bdde7ff9f0cfa1ea4376b7a952bbaed9988d0a))
+
+## [0.0.1-next.7](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.1-next.6...federated-catalogue-models-v0.0.1-next.7) (2025-05-28)
+
+
+### Features
+
+* add data types with fully qualified names ([993eb09](https://github.com/twinfoundation/federated-catalogue/commit/993eb09e25f6caad5d82a3908a2ba648900f5ca7))
+
+
+### Bug Fixes
+
+* broken docs ([4588d86](https://github.com/twinfoundation/federated-catalogue/commit/4588d861575522da5374291167d57bacd1b21867))
+
+## [0.0.1-next.6](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.1-next.5...federated-catalogue-models-v0.0.1-next.6) (2025-05-23)
+
+
+### Miscellaneous Chores
+
+* **federated-catalogue-models:** Synchronize repo versions
+
+## [0.0.1-next.5](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.1-next.4...federated-catalogue-models-v0.0.1-next.5) (2025-05-23)
+
+
+### Features
+
+* consistent component naming with other repos ([83fc03d](https://github.com/twinfoundation/federated-catalogue/commit/83fc03dee3846600ae6a45d710248a0ae60af570))
+
+## [0.0.1-next.4](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.1-next.3...federated-catalogue-models-v0.0.1-next.4) (2025-05-23)
+
+
+### Miscellaneous Chores
+
+* **federated-catalogue-models:** Synchronize repo versions
+
+## [0.0.1-next.3](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.1-next.2...federated-catalogue-models-v0.0.1-next.3) (2025-05-22)
+
+
+### Features
+
+* version 0 federated catalogue ([#2](https://github.com/twinfoundation/federated-catalogue/issues/2)) ([93fb8bd](https://github.com/twinfoundation/federated-catalogue/commit/93fb8bdbb03aa781ef9e8dc4053beea1b397cc36))
+
+## [0.0.1-next.2](https://github.com/twinfoundation/federated-catalogue/compare/federated-catalogue-models-v0.0.1-next.1...federated-catalogue-models-v0.0.1-next.2) (2025-05-22)
+
+
+### Features
+
+* version 0 federated catalogue ([#2](https://github.com/twinfoundation/federated-catalogue/issues/2)) ([93fb8bd](https://github.com/twinfoundation/federated-catalogue/commit/93fb8bdbb03aa781ef9e8dc4053beea1b397cc36))
+
+## v0.0.1
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/federated-catalogue-models - Examples

package/docs/reference/classes/FederatedCatalogueContextInstances.md

@@ -0,0 +1,29 @@
+# Class: `abstract` FederatedCatalogueContextInstances
+
+The LD context instances concerning the Federated Catalogue.
+
+## Constructors
+
+### Constructor
+
+> **new FederatedCatalogueContextInstances**(): `FederatedCatalogueContextInstances`
+
+#### Returns
+
+`FederatedCatalogueContextInstances`
+
+## Properties
+
+### DEFAULT\_LD\_CONTEXT\_ENTRY\_LIST
+
+> `static` **DEFAULT\_LD\_CONTEXT\_ENTRY\_LIST**: [`FederatedCatalogueContextType`](../type-aliases/FederatedCatalogueContextType.md)
+
+The LD Context of a list of Catalogue entries.
+
+***
+
+### DEFAULT\_LD\_CONTEXT\_ENTRY
+
+> `static` **DEFAULT\_LD\_CONTEXT\_ENTRY**: [`FederatedCatalogueContextType`](../type-aliases/FederatedCatalogueContextType.md)
+
+The LD Context of a Catalogue entry.

package/docs/reference/classes/FederatedCatalogueDataTypes.md

@@ -0,0 +1,25 @@
+# Class: FederatedCatalogueDataTypes
+
+Handle all the data types for federated catalogue.
+
+## Constructors
+
+### Constructor
+
+> **new FederatedCatalogueDataTypes**(): `FederatedCatalogueDataTypes`
+
+#### Returns
+
+`FederatedCatalogueDataTypes`
+
+## Methods
+
+### registerTypes()
+
+> `static` **registerTypes**(): `void`
+
+Register all the data types.
+
+#### Returns
+
+`void`

package/docs/reference/index.md

@@ -0,0 +1,58 @@
+# @twin.org/federated-catalogue-models
+
+## Classes
+
+- [FederatedCatalogueDataTypes](classes/FederatedCatalogueDataTypes.md)
+- [FederatedCatalogueContextInstances](classes/FederatedCatalogueContextInstances.md)
+
+## Interfaces
+
+- [IComplianceCredential](interfaces/IComplianceCredential.md)
+- [IComplianceEvidence](interfaces/IComplianceEvidence.md)
+- [IComplianceVerificationResult](interfaces/IComplianceVerificationResult.md)
+- [ICredential](interfaces/ICredential.md)
+- [IFederatedCatalogueComponent](interfaces/IFederatedCatalogueComponent.md)
+- [IVerificationResult](interfaces/IVerificationResult.md)
+- [ICatalogueEntryGetRequest](interfaces/ICatalogueEntryGetRequest.md)
+- [ICompliancePresentationRequest](interfaces/ICompliancePresentationRequest.md)
+- [IDataResourceGetResponse](interfaces/IDataResourceGetResponse.md)
+- [IDataResourceListRequest](interfaces/IDataResourceListRequest.md)
+- [IDataResourceListResponse](interfaces/IDataResourceListResponse.md)
+- [IDataSpaceConnectorGetResponse](interfaces/IDataSpaceConnectorGetResponse.md)
+- [IDataSpaceConnectorListRequest](interfaces/IDataSpaceConnectorListRequest.md)
+- [IDataSpaceConnectorListResponse](interfaces/IDataSpaceConnectorListResponse.md)
+- [IFederatedCatalogueGetRequest](interfaces/IFederatedCatalogueGetRequest.md)
+- [IParticipantGetResponse](interfaces/IParticipantGetResponse.md)
+- [IParticipantListRequest](interfaces/IParticipantListRequest.md)
+- [IParticipantListResponse](interfaces/IParticipantListResponse.md)
+- [IServiceOfferingGetResponse](interfaces/IServiceOfferingGetResponse.md)
+- [IServiceOfferingListRequest](interfaces/IServiceOfferingListRequest.md)
+- [IServiceOfferingListResponse](interfaces/IServiceOfferingListResponse.md)
+- [IDataResourceCredential](interfaces/IDataResourceCredential.md)
+- [IDataResourceEntry](interfaces/IDataResourceEntry.md)
+- [IDataResourceList](interfaces/IDataResourceList.md)
+- [IDataSpaceConnector](interfaces/IDataSpaceConnector.md)
+- [IDataSpaceConnectorCredential](interfaces/IDataSpaceConnectorCredential.md)
+- [IDataSpaceConnectorEntry](interfaces/IDataSpaceConnectorEntry.md)
+- [IDataSpaceConnectorList](interfaces/IDataSpaceConnectorList.md)
+- [IParticipantCredential](interfaces/IParticipantCredential.md)
+- [IParticipantEntry](interfaces/IParticipantEntry.md)
+- [IParticipantList](interfaces/IParticipantList.md)
+- [IServiceOfferingCredential](interfaces/IServiceOfferingCredential.md)
+- [IServiceOfferingEntry](interfaces/IServiceOfferingEntry.md)
+- [IServiceOfferingList](interfaces/IServiceOfferingList.md)
+
+## Type Aliases
+
+- [ICatalogueEntry](type-aliases/ICatalogueEntry.md)
+- [FederatedCatalogueContextType](type-aliases/FederatedCatalogueContextType.md)
+- [FederatedCatalogueContexts](type-aliases/FederatedCatalogueContexts.md)
+- [FederatedCatalogueEntryType](type-aliases/FederatedCatalogueEntryType.md)
+- [FederatedCatalogueTypes](type-aliases/FederatedCatalogueTypes.md)
+- [VerificationFailureReasons](type-aliases/VerificationFailureReasons.md)
+
+## Variables
+
+- [FederatedCatalogueContexts](variables/FederatedCatalogueContexts.md)
+- [FederatedCatalogueTypes](variables/FederatedCatalogueTypes.md)
+- [VerificationFailureReasons](variables/VerificationFailureReasons.md)

package/docs/reference/interfaces/ICatalogueEntryGetRequest.md

@@ -0,0 +1,37 @@
+# Interface: ICatalogueEntryGetRequest
+
+Get a Catalogue Entry.
+
+## Extends
+
+- [`IFederatedCatalogueGetRequest`](IFederatedCatalogueGetRequest.md)
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The parameters from the path.
+
+#### id
+
+> **id**: `string`
+
+The ID of the entry (Participant, Service, etc.) to get.
+
+***
+
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+#### Inherited from
+
+[`IFederatedCatalogueGetRequest`](IFederatedCatalogueGetRequest.md).[`headers`](IFederatedCatalogueGetRequest.md#headers)