diff --git a/proto/iotics/api/common.proto b/proto/iotics/api/common.proto index 049a1c3..b8dd8dd 100644 --- a/proto/iotics/api/common.proto +++ b/proto/iotics/api/common.proto @@ -65,7 +65,7 @@ message Literal { string value = 2; } -// Uri is a metadata property type describing am Uri. +// Uri is a metadata property type describing a Uri. message Uri { // String representation of the value string value = 1; diff --git a/proto/iotics/api/input.proto b/proto/iotics/api/input.proto index 7fe3aee..5a01b0e 100644 --- a/proto/iotics/api/input.proto +++ b/proto/iotics/api/input.proto @@ -42,7 +42,7 @@ service InputAPI { message InputID { // Input Identifier string representation (simple string) (unique within the scope of a twin identifier's input set) string id = 1; - // Twin identifier string representation (simple string) (twin to which the feed belongs) + // Twin identifier string representation (simple string) (twin to which the input belongs) string twinId = 2; // Host identifier string representation (simple string) (Host to which the twin belongs) string hostId = 3; @@ -203,7 +203,7 @@ message UpsertInputWithMeta { } // --------------------------------------- -// InputMessage describe a message that can be sent to an input +// InputMessage describes a message that can be sent to an input message InputMessage { // OccurredAt is the UTC timestamp of the message. // Typically this is either the time at which an application sent this message diff --git a/proto/iotics/api/interest.proto b/proto/iotics/api/interest.proto index bcc4398..d8edabd 100644 --- a/proto/iotics/api/interest.proto +++ b/proto/iotics/api/interest.proto @@ -21,7 +21,7 @@ option php_namespace = "Iotics\\Api"; // --------------------------------------------------------------------------------------------------------------------- -// InterestAPI enables creation and management of interests between a twin and a feed. +// InterestAPI enables creation and management of interests between a twin and a feed or an input. service InterestAPI { // Fetch feed data for this interest. (local and remote) rpc FetchInterests(FetchInterestRequest) returns (stream FetchInterestResponse) {} diff --git a/proto/iotics/api/search.proto b/proto/iotics/api/search.proto index 432c2bf..502a0d6 100644 --- a/proto/iotics/api/search.proto +++ b/proto/iotics/api/search.proto @@ -39,7 +39,7 @@ service SearchAPI { } // ResponseType describes the type of the search response. -// - FULL - Returns full responses including twins and feeds identifiers, labels/comments (for all languages if no language provided), properties and location +// - FULL - Returns full responses including twins, feeds and inputs identifiers, properties and location // - LOCATED - Returns located responses including twins identifier, location and label (for the provided language or default) // - MINIMAL - Returns minimal responses including twins identifier only enum ResponseType { @@ -115,7 +115,7 @@ message AdvancedSearchRequest { // --------------------------------------------------------------------------------------------------------------------- // SearchResponse describes a result associated to a search request. -// It contains all the matching twins/feeds according to the request scope/range/lang/filters in the expected response type format. +// It contains all the matching twins/feeds/inputs according to the request scope/range/lang/filters in the expected response type format. // In the decentralised iotics operating environment, each node in the network generates a response and the client is expected to // receive a stream of response messages. message SearchResponse { diff --git a/proto/iotics/api/twin.proto b/proto/iotics/api/twin.proto index 3b1a181..c5508d3 100644 --- a/proto/iotics/api/twin.proto +++ b/proto/iotics/api/twin.proto @@ -30,8 +30,8 @@ service TwinAPI { // CreateTwin creates a twin. rpc CreateTwin(CreateTwinRequest) returns (CreateTwinResponse) {} - // UpsertTwin creates or update a twin with its metadata + the twin feeds with their metadata. - // The full state is applied (ie. if the operation succeeds the state of the twin/feeds will be the one + // UpsertTwin creates or update a twin with its metadata + the twin feeds and inputs with their metadata. + // The full state is applied (ie. if the operation succeeds the state of the twin, feeds and inputs will be the one // described in the payload) rpc UpsertTwin(UpsertTwinRequest) returns (UpsertTwinResponse) {} @@ -250,10 +250,10 @@ message UpdateTwinResponse { Payload payload = 2; } -// UpsertTwinRequest describes the full state of a twin + its feeds to create or update (full update) +// UpsertTwinRequest describes the full state of a twin + its feeds and inputs to create or update (full update) message UpsertTwinRequest { - // UpsertTwinRequest payload. This state will be applied to the twin/feeds + // UpsertTwinRequest payload. This state will be applied to the twin, feeds and inputs message Payload { // Unique ID of the twin to create/update @@ -279,7 +279,7 @@ message UpsertTwinRequest { Payload payload = 2; } -// UpsertTwinResponse is received when a twin and its feeds have been created/updated. +// UpsertTwinResponse is received when a twin and its feeds and inputs have been created/updated. message UpsertTwinResponse { // Payload identifies the twin which was created.