Skip to content

Commit

Permalink
@martin4all's comment
Browse files Browse the repository at this point in the history
  • Loading branch information
HeikoTheissen committed Feb 11, 2025
1 parent 939548f commit fb4df21
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 4 deletions.
2 changes: 1 addition & 1 deletion vocabularies/Common.json
Original file line number Diff line number Diff line change
Expand Up @@ -1350,7 +1350,7 @@
"$AppliesTo": ["EntityContainer"],
"@Common.Experimental": true,
"@Core.Description": "Channel for WebSocket connections",
"@Core.LongDescription": "Messages sent over the channel follow the [ABAP Push Channel Protocol](https://community.sap.com/t5/application-development-blog-posts/specification-of-the-push-channel-protocol-pcp/ba-p/13137541).\nTo consume a channel, the client opens a web socket connection at the [`WebSocketBaseURL`](#WebSocketBaseURL)\nfollowed by URL parameters\n- parameter name = annotation qualifier, parameter value = channel ID (see below)\n- parameter name = `relatedService`, parameter value = base URL (relative to server root) of the OData service of the app\n\n<dl>Supported qualifiers and channel IDs:\n<dt>`sideEffects` <dd>Notifications about side effects to be triggered by the client (channel ID = non-null annotation value)\n<dt>`progressIndicator` <dd>Progress notifications for long-running operations.\nThe annotation value is a space-separated list of the channel ID followed by qualified names of operations.\n</dl>"
"@Core.LongDescription": "Messages sent over the channel follow the [ABAP Push Channel Protocol](https://community.sap.com/t5/application-development-blog-posts/specification-of-the-push-channel-protocol-pcp/ba-p/13137541).\nTo consume a channel, the client opens a web socket connection at the [`WebSocketBaseURL`](#WebSocketBaseURL)\nfollowed by URL parameters\n- parameter name = annotation qualifier, parameter value = channel ID (see below)\n- parameter name = `relatedService`, parameter value = base URL (relative to server root) of the OData service of the app\n\n<dl>Supported qualifiers and channel IDs:\n<dt>`sideEffects` <dd>Notifications about side effects to be triggered by the client.\nThe annotation value is the channel ID = service definition name.\n<dt>`progressIndicator` <dd>Progress notifications for long-running operations.\nThe annotation value is a space-separated list of the channel ID = service definition name followed by qualified names of operations.\n</dl>"
}
}
}
2 changes: 1 addition & 1 deletion vocabularies/Common.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Term|Type|Description
[mediaUploadLink](Common.xml#L1482) *([Experimental](Common.md#Experimental))*|URL|<a name="mediaUploadLink"></a>URL for uploading new media content to a Document Management Service<br>In contrast to the `@odata.mediaEditLink` this URL allows to upload new media content without directly changing a stream property or media resource. The upload request typically uses HTTP POST with `Content-Type: multipart/form-data` following RFC 7578. The upload request must contain one multipart representing the content of the file. The `name` parameter in the `Content-Disposition` header (as described in RFC 7578) is irrelevant, but the `filename` parameter is expected. If the request succeeds the response will contain a JSON body of `Content-Type: application/json` with a JSON property `readLink`. The newly uploaded media resource can be linked to the stream property by changing the `@odata.mediaReadLink` to the value of this `readLink` in a subsequent PATCH request to the OData entity.
[PrimitivePropertyPath](Common.xml#L1497) *([Experimental](Common.md#Experimental))*|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|<a name="PrimitivePropertyPath"></a>A term or term property with this tag whose type is (a collection of) `Edm.PropertyPath` MUST resolve to a primitive structural property
[WebSocketBaseURL](Common.xml#L1502) *([Experimental](Common.md#Experimental))*|URL|<a name="WebSocketBaseURL"></a>Base URL for WebSocket connections<br>This annotation MUST be unqualified.
[WebSocketChannel](Common.xml#L1510) *([Experimental](Common.md#Experimental))*|String?|<a name="WebSocketChannel"></a>Channel for WebSocket connections<br><p>Messages sent over the channel follow the <a href="https://community.sap.com/t5/application-development-blog-posts/specification-of-the-push-channel-protocol-pcp/ba-p/13137541">ABAP Push Channel Protocol</a>. To consume a channel, the client opens a web socket connection at the <a href="#WebSocketBaseURL"><code>WebSocketBaseURL</code></a> followed by URL parameters</p> <ul> <li>parameter name = annotation qualifier, parameter value = channel ID (see below)</li> <li>parameter name = <code>relatedService</code>, parameter value = base URL (relative to server root) of the OData service of the app</li> </ul> <dl>Supported qualifiers and channel IDs: <dt>`sideEffects` <dd>Notifications about side effects to be triggered by the client (channel ID = non-null annotation value) <dt>`progressIndicator` <dd>Progress notifications for long-running operations. The annotation value is a space-separated list of the channel ID followed by qualified names of operations. </dl>
[WebSocketChannel](Common.xml#L1510) *([Experimental](Common.md#Experimental))*|String?|<a name="WebSocketChannel"></a>Channel for WebSocket connections<br><p>Messages sent over the channel follow the <a href="https://community.sap.com/t5/application-development-blog-posts/specification-of-the-push-channel-protocol-pcp/ba-p/13137541">ABAP Push Channel Protocol</a>. To consume a channel, the client opens a web socket connection at the <a href="#WebSocketBaseURL"><code>WebSocketBaseURL</code></a> followed by URL parameters</p> <ul> <li>parameter name = annotation qualifier, parameter value = channel ID (see below)</li> <li>parameter name = <code>relatedService</code>, parameter value = base URL (relative to server root) of the OData service of the app</li> </ul> <dl>Supported qualifiers and channel IDs: <dt>`sideEffects` <dd>Notifications about side effects to be triggered by the client. The annotation value is the channel ID = service definition name. <dt>`progressIndicator` <dd>Progress notifications for long-running operations. The annotation value is a space-separated list of the channel ID = service definition name followed by qualified names of operations. </dl>

<a name="TextFormatType"></a>
## [TextFormatType](Common.xml#L134)
Expand Down
5 changes: 3 additions & 2 deletions vocabularies/Common.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1518,9 +1518,10 @@ followed by URL parameters
- parameter name = `relatedService`, parameter value = base URL (relative to server root) of the OData service of the app

&lt;dl&gt;Supported qualifiers and channel IDs:
&lt;dt&gt;`sideEffects` &lt;dd&gt;Notifications about side effects to be triggered by the client (channel ID = non-null annotation value)
&lt;dt&gt;`sideEffects` &lt;dd&gt;Notifications about side effects to be triggered by the client.
The annotation value is the channel ID = service definition name.
&lt;dt&gt;`progressIndicator` &lt;dd&gt;Progress notifications for long-running operations.
The annotation value is a space-separated list of the channel ID followed by qualified names of operations.
The annotation value is a space-separated list of the channel ID = service definition name followed by qualified names of operations.
&lt;/dl&gt;</String>
</Annotation>
</Term>
Expand Down

0 comments on commit fb4df21

Please sign in to comment.