sdk-js

@nevermined-io/sdk - v3.0.44 / WebService

Interface: WebService

Interface describing an asset of type service

Table of contents

Properties

Properties

chargeType

Optional chargeType: ChargeType

The type of charge for the service (fixed or dymanic). If fixed the amount of credits to charge will be always the same.

Defined in

src/types/DDOTypes.ts:226


encryptedAttributes

Optional encryptedAttributes: string

Defined in

src/types/DDOTypes.ts:220


endpoints

Optional endpoints: { [verb: string]: string; }[]

List of endpoints available for the service

Defined in

src/types/DDOTypes.ts:210


implementsQueryProtocol

Optional implementsQueryProtocol: boolean

Flag to indicate if the service implements the Nevermined Query Protocol. See https://docs.nevermined.io/docs/protocol/query-protocol

Defined in

src/types/DDOTypes.ts:246


internalAttributes

Optional internalAttributes: WebServiceInternalAttributes

Defined in

src/types/DDOTypes.ts:218


isNeverminedHosted

Optional isNeverminedHosted: boolean

Flag to indicate if the service is hosted by Nevermined infrastructure. If true, the service/agent will be running using the Nevermined Backend service.

Defined in

src/types/DDOTypes.ts:232


openEndpoints

Optional openEndpoints: string[]

List of open endpoints available for the service. These endpoints are not protected. This attribute is useful to indicate which endpoints are available for public access (documentation, definitions, etc).

Defined in

src/types/DDOTypes.ts:216


queryProtocolVersion

Optional queryProtocolVersion: string

The version of the Query Protocol implemented by the service.

Defined in

src/types/DDOTypes.ts:251


serviceHost

Optional serviceHost: string

Host of the service where the service is running. This attribute when is given AND the service is hosted by Nevermined or implements the Query Protocol, allows to populate automatically the endpoints using the service host. Example: https://my-service.com or https://backend.nevermined.app

Defined in

src/types/DDOTypes.ts:240


type

Optional type: "Other" | "RESTful" | "GrapQL" | "RPC"

Type of Web service

Defined in

src/types/DDOTypes.ts:205