Class: Catalogue

A catalogue service is a subclass of serviceOffering used to browse, search, filter services and resources.

URI: gx:Catalogue

classDiagram class Catalogue ServiceOffering <|-- Catalogue Catalogue : aggregationOf Catalogue : dataAccountExport Catalogue --|> DataAccountExport : dataAccountExport Catalogue : dataProtectionRegime Catalogue --|> PersonalDataProtectionRegime : dataProtectionRegime Catalogue : dependsOn Catalogue --|> ServiceOffering : dependsOn Catalogue : description Catalogue : endpoint Catalogue --|> Endpoint : endpoint Catalogue : getVerifiableCredentialsIDs Catalogue : hostedOn Catalogue : keyword Catalogue : name Catalogue : policy Catalogue : providedBy Catalogue --|> LegalPerson : providedBy Catalogue : provisionType Catalogue : termsAndConditions Catalogue --|> TermsAndConditions : termsAndConditions

Inheritance

Slots

Name Cardinality and Range Description Inheritance
getVerifiableCredentialsIDs 1..*
String		 a route used to synchronize catalogues and retrieve the list of Verifiable Cr... direct
providedBy 1..1
LegalPerson		 A resolvable link to the participant self-description providing the service ServiceOffering
name 1..1
String		 Human readable name of the service offering ServiceOffering
termsAndConditions 1..*
TermsAndConditions		 A resolvable link to the Terms and Conditions applying to that service ServiceOffering
policy 1..*
String		 One or more policies expressed using a DSL (e ServiceOffering
dataProtectionRegime 0..*
PersonalDataProtectionRegime		 One or more data protection regimes ServiceOffering
dataAccountExport 1..*
DataAccountExport		 One or more methods to export data out of the service ServiceOffering
description 0..1
String		 A description in natural language ServiceOffering
keyword 0..*
String		 Keywords that describe / tag the service ServiceOffering
provisionType 0..1
String		 Provision type of the service ServiceOffering
endpoint 0..1
Endpoint		 Endpoint through which the Service Offering can be accessed ServiceOffering
hostedOn 0..*
String		 List of Resource references where service is hosted and can be instantiated ServiceOffering
dependsOn 0..*
ServiceOffering		 A resolvable link to the service offering self-description related to the ser... ServiceOffering
aggregationOf 0..*
String		 A resolvable link to the resources self-description related to the service an... ServiceOffering

Identifier and Mapping Information

Schema Source

  • from schema: https://registry.lab.gaia-x.eu/development/api/trusted-shape-registry/v1/shapes/jsonld/trustframework#

Mappings

Mapping Type Mapped Value
self gx:Catalogue
native gx:Catalogue

LinkML Source

Direct

name: Catalogue
description: A catalogue service is a subclass of serviceOffering used to browse,
  search, filter services and resources.
from_schema: https://registry.lab.gaia-x.eu/development/api/trusted-shape-registry/v1/shapes/jsonld/trustframework#
is_a: ServiceOffering
attributes:
  getVerifiableCredentialsIDs:
    name: getVerifiableCredentialsIDs
    description: a route used to synchronize catalogues and retrieve the list of Verifiable
      Credentials (issuer, id).
    from_schema: https://registry.lab.gaia-x.eu/development/api/trusted-shape-registry/v1/shapes/jsonld/trustframework#
    rank: 1000
    multivalued: true
    required: true
    inlined: true
    inlined_as_list: true
tree_root: true

Induced

name: Catalogue
description: A catalogue service is a subclass of serviceOffering used to browse,
  search, filter services and resources.
from_schema: https://registry.lab.gaia-x.eu/development/api/trusted-shape-registry/v1/shapes/jsonld/trustframework#
is_a: ServiceOffering
attributes:
  getVerifiableCredentialsIDs:
    name: getVerifiableCredentialsIDs
    description: a route used to synchronize catalogues and retrieve the list of Verifiable
      Credentials (issuer, id).
    from_schema: https://registry.lab.gaia-x.eu/development/api/trusted-shape-registry/v1/shapes/jsonld/trustframework#
    rank: 1000
    multivalued: true
    alias: getVerifiableCredentialsIDs
    owner: Catalogue
    domain_of:
    - Catalogue
    range: string
    required: true
    inlined: true
    inlined_as_list: true
  providedBy:
    name: providedBy
    description: A resolvable link to the participant self-description providing the
      service.
    title: provided by
    from_schema: https://registry.lab.gaia-x.eu/development/api/trusted-shape-registry/v1/shapes/jsonld/trustframework#
    rank: 1000
    alias: providedBy
    owner: Catalogue
    domain_of:
    - ServiceOffering
    range: LegalPerson
    required: true
  name:
    name: name
    description: Human readable name of the service offering.
    title: name
    from_schema: https://registry.lab.gaia-x.eu/development/api/trusted-shape-registry/v1/shapes/jsonld/trustframework#
    alias: name
    owner: Catalogue
    domain_of:
    - Resource
    - ServiceOffering
    range: string
    required: true
  termsAndConditions:
    name: termsAndConditions
    description: A resolvable link to the Terms and Conditions applying to that service.
    title: terms and conditions
    from_schema: https://registry.lab.gaia-x.eu/development/api/trusted-shape-registry/v1/shapes/jsonld/trustframework#
    multivalued: true
    alias: termsAndConditions
    owner: Catalogue
    domain_of:
    - GaiaXTermsAndConditions
    - Issuer
    - ServiceOffering
    range: TermsAndConditions
    required: true
  policy:
    name: policy
    description: One or more policies expressed using a DSL (e.g., Rego or ODRL).
    title: policy
    from_schema: https://registry.lab.gaia-x.eu/development/api/trusted-shape-registry/v1/shapes/jsonld/trustframework#
    rank: 1000
    multivalued: true
    alias: policy
    owner: Catalogue
    domain_of:
    - ServiceOffering
    range: string
    required: true
  dataProtectionRegime:
    name: dataProtectionRegime
    description: One or more data protection regimes.
    title: data protection regime
    from_schema: https://registry.lab.gaia-x.eu/development/api/trusted-shape-registry/v1/shapes/jsonld/trustframework#
    rank: 1000
    multivalued: true
    alias: dataProtectionRegime
    owner: Catalogue
    domain_of:
    - ServiceOffering
    range: PersonalDataProtectionRegime
    required: false
  dataAccountExport:
    name: dataAccountExport
    description: One or more  methods to export data out of the service.
    title: data account export
    from_schema: https://registry.lab.gaia-x.eu/development/api/trusted-shape-registry/v1/shapes/jsonld/trustframework#
    rank: 1000
    multivalued: true
    alias: dataAccountExport
    owner: Catalogue
    domain_of:
    - ServiceOffering
    range: DataAccountExport
    required: true
  description:
    name: description
    description: A description in natural language.
    title: description
    from_schema: https://registry.lab.gaia-x.eu/development/api/trusted-shape-registry/v1/shapes/jsonld/trustframework#
    alias: description
    owner: Catalogue
    domain_of:
    - Resource
    - ServiceOffering
    range: string
    required: false
  keyword:
    name: keyword
    description: Keywords that describe / tag the service.
    title: keyword
    from_schema: https://registry.lab.gaia-x.eu/development/api/trusted-shape-registry/v1/shapes/jsonld/trustframework#
    rank: 1000
    multivalued: true
    alias: keyword
    owner: Catalogue
    domain_of:
    - ServiceOffering
    range: string
    required: false
  provisionType:
    name: provisionType
    description: Provision type of the service
    title: provision type
    from_schema: https://registry.lab.gaia-x.eu/development/api/trusted-shape-registry/v1/shapes/jsonld/trustframework#
    rank: 1000
    alias: provisionType
    owner: Catalogue
    domain_of:
    - ServiceOffering
    range: string
    required: false
  endpoint:
    name: endpoint
    description: Endpoint through which the Service Offering can be accessed.
    title: endpoint
    from_schema: https://registry.lab.gaia-x.eu/development/api/trusted-shape-registry/v1/shapes/jsonld/trustframework#
    rank: 1000
    alias: endpoint
    owner: Catalogue
    domain_of:
    - ServiceOffering
    range: Endpoint
    required: false
  hostedOn:
    name: hostedOn
    description: List of Resource references where service is hosted and can be instantiated.
      Can refer to availabilty zones, data centers, regions, etc.
    title: hosted on
    from_schema: https://registry.lab.gaia-x.eu/development/api/trusted-shape-registry/v1/shapes/jsonld/trustframework#
    rank: 1000
    multivalued: true
    alias: hostedOn
    owner: Catalogue
    domain_of:
    - ServiceOffering
    range: string
    required: false
    any_of:
    - range: Resource
    - range: ServiceOffering
  dependsOn:
    name: dependsOn
    description: A resolvable link to the service offering self-description related
      to the service and that can exist independently of it.
    title: depends on
    from_schema: https://registry.lab.gaia-x.eu/development/api/trusted-shape-registry/v1/shapes/jsonld/trustframework#
    rank: 1000
    multivalued: true
    alias: dependsOn
    owner: Catalogue
    domain_of:
    - ServiceOffering
    range: ServiceOffering
    required: false
  aggregationOf:
    name: aggregationOf
    description: A resolvable link to the resources self-description related to the
      service and that can exist independently of it.
    title: aggregation of
    from_schema: https://registry.lab.gaia-x.eu/development/api/trusted-shape-registry/v1/shapes/jsonld/trustframework#
    multivalued: true
    alias: aggregationOf
    owner: Catalogue
    domain_of:
    - Resource
    - ServiceOffering
    range: string
    required: false
    any_of:
    - range: Resource
    - range: ServiceOffering
tree_root: true