Skip to content

Commit f6f37aa

Browse files
fix anchors for due to documentation changes
- fixed blog posts - fixed open-api docs
1 parent 7efc447 commit f6f37aa

49 files changed

Lines changed: 80 additions & 80 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

documentation/src/main/resources/_posts/2018-02-07-milestone-announcement-020-M1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The Ditto team is proud to announce the next milestone release.
1616
Have a look at the Milestone [0.2.0-M1 release notes](release_notes_020-M1.html).
1717

1818
The main changes are
19-
* being able to [search in namespaces](httpapi-search.html#query-parameters) which can speed up search queries when applied
19+
* being able to [search in namespaces](httpapi-search.html#examples) which can speed up search queries when applied
2020
to a large population of digital twins
2121
* the enhancement of our [Feature entity](basic-feature.html) by [Definitions](basic-feature.html#feature-definition)
2222
which lays the foundation for using Features in a typesafe way (later by enforcing the schema with the help of an

documentation/src/main/resources/_posts/2018-12-05-example-command-and-control.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ The request is now open to receive a command for 60 seconds before it is termina
193193
194194
### Send a Ditto message
195195
196-
Now we can use the [Ditto Messages API](protocol-specification-things-messages.html#using-the-messages-api) to send a
196+
Now we can use the [Ditto Messages API](protocol-specification-things-messages.html#examples) to send a
197197
message to the device waiting for a command:
198198
```bash
199199
curl -i -X POST 'https://ditto.eclipseprojects.io/api/2/things/org.eclipse.ditto:teapot/inbox/messages/brew?timeout=60' \

documentation/src/main/resources/_posts/2021-09-29-kafka-connectivity.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The time has come to support consuming as well.
1818
A Kafka connection behaves slightly different from other consuming Connections in Ditto.
1919
The following aspects are special:
2020
* [Backpressure by using acknowledgements](connectivity-protocol-bindings-kafka2.html#quality-of-service)
21-
* [Preserve order of messages on redelivery due to failed acknowledgements](connectivity-protocol-bindings-kafka2.html#backpressure-by-using-acknowledgements)
21+
* [Preserve order of messages on redelivery due to failed acknowledgements](connectivity-protocol-bindings-kafka2.html#backpressure-via-acknowledgements)
2222
* [Expiry of messages](connectivity-protocol-bindings-kafka2.html#message-expiry)
2323

2424
### Scalability

documentation/src/main/resources/_posts/2021-11-03-oauth2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ placeholder. The unencoded headers and body are as follows.
8282

8383
# Create the connection
8484

85-
[Create a connection](connectivity-manage-connections.html#create-connection)
85+
[Create a connection](connectivity-manage-connections.html#create-a-connection)
8686
publishing twin events to the event publishing webhook using OAuth2 credentials.
8787
The `tokenEndpoint` field is set to the access token webhook.
8888

documentation/src/main/resources/_posts/2021-12-20-http-live-channel.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,21 @@ toc: true
1111
---
1212

1313
The upcoming release of Eclipse Ditto **version 2.3.0** will support sending commands via the HTTP API
14-
directly to devices using the [live channel](protocol-twinlive.html#live) by just adding the `channel=live`
15-
query parameter to the same HTTP API request which would target the [twin](protocol-twinlive.html#twin).
14+
directly to devices using the [live channel](protocol-twinlive.html#live-channel) by just adding the `channel=live`
15+
query parameter to the same HTTP API request which would target the [twin](protocol-twinlive.html#twin-channel).
1616

1717
## HTTP Live channel
1818

19-
Ditto supports sending all kind of [Thing commands](protocol-specification-things.html#commands) via
19+
Ditto supports sending all kind of [Thing commands](protocol-specification-things.html#create-and-modify-commands) via
2020
the `live` channel directly to devices.
2121
When sending a `live` command to a device, the device is responsible for sending a correlated and correct response
2222
in [Ditto Protocol](protocol-overview.html).
2323

2424
Ditto supports two types of `channel`s for communication.
2525

26-
* [twin](protocol-twinlive.html#twin): The default value of the channel parameter is `twin`
26+
* [twin](protocol-twinlive.html#twin-channel): The default value of the channel parameter is `twin`
2727
to communicate with the persisted **twin** representation.
28-
* [live](protocol-twinlive.html#live): The `channel` parameter can be changed to `live`
28+
* [live](protocol-twinlive.html#live-channel): The `channel` parameter can be changed to `live`
2929
to communicate with the real device.
3030

3131
{% include note.html content="In order to use the live channel, the device receiving live commands must be able to understand

documentation/src/main/resources/_posts/2021-12-22-live-channel-condition.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ sidebar: false
1010
toc: true
1111
---
1212

13-
After the added option to target the [live channel](protocol-twinlive.html#live) by adding the `channel=live` to HTTP
13+
After the added option to target the [live channel](protocol-twinlive.html#live-channel) by adding the `channel=live` to HTTP
1414
requests (see also [blog post about "HTTP live channel"](2021-12-20-http-live-channel.html)), Eclipse Ditto
1515
**version 2.3.0** will in addition support to define a
1616
[live channel condition](basic-conditional-requests.html#live-channel-condition), which, when evaluating to `true`,
17-
will retrieve data from a device via the live channel, or fall back to the persisted [twin](protocol-twinlive.html#twin)
17+
will retrieve data from a device via the live channel, or fall back to the persisted [twin](protocol-twinlive.html#twin-channel)
1818
otherwise.
1919

2020
{% include note.html content="In order to use the live channel, the device receiving live commands must be able to understand
@@ -72,15 +72,15 @@ GET /api/2/things/my.namespace:my-polling-device-1/features/temperature/properti
7272
```
7373

7474
The specified `live-channel-condition` will evaluate to `true`, meaning that the retrieve is transformed to a
75-
[live command](protocol-twinlive.html#live) and sent to the device, e.g. connected via a
75+
[live command](protocol-twinlive.html#live-channel) and sent to the device, e.g. connected via a
7676
[managed connection](basic-connections.html).
7777
Upon receiving the "live retrieve" at the device, the device can create a command response correlated with the same
7878
`correlation-id` and send it back to Ditto with the current value.
7979
This value is then returned as result of the `GET`, the HTTP response header `channel` will indicate that the data was
8080
sent by the device by having the value `live`.
8181

8282
If the device does not answer with a correctly correlated response within the given `timeout`, the request will fall back
83-
to the [twin](protocol-twinlive.html#twin) channel, retrieving the data from the last known persisted temperature value
83+
to the [twin](protocol-twinlive.html#twin-channel) channel, retrieving the data from the last known persisted temperature value
8484
in the twin managed by Ditto.
8585
The HTTP response header `channel` will indicate that the data was received by the persisted twin by having the value
8686
`twin`.

documentation/src/main/resources/_posts/2022-01-21-release-announcement-230.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ toc: false
1212

1313
The Eclipse Ditto teams announces availability of Eclipse Ditto [2.3.0](https://projects.eclipse.org/projects/iot.ditto/releases/2.3.0).
1414

15-
It contains mainly new features around the Ditto ["live" channel](protocol-twinlive.html#live) which can be used to
15+
It contains mainly new features around the Ditto ["live" channel](protocol-twinlive.html#live-channel) which can be used to
1616
directly interact with devices.
1717

1818
Such live commands may now be easily [created via the HTTP API](2021-12-20-http-live-channel.html) - and in addition
19-
a conventional API call targeting the persisted [twin](protocol-twinlive.html#twin) may now be automatically converted
19+
a conventional API call targeting the persisted [twin](protocol-twinlive.html#twin-channel) may now be automatically converted
2020
to a live command, based on a passed [live channel condition](2021-12-22-live-channel-condition.html).
2121

2222
With that, we are proud that we now can provide a really powerful addition to Ditto's "Digital Twin pattern":

documentation/src/main/resources/_posts/2023-10-09-ditto-benchmark.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ Example message:
220220
device_id:org.eclipse.ditto:test-thing-1,ditto_message:y!{"topic":"org.eclipse.ditto/test-thing-1/things/twin/commands/modify","path":"features/coffee-brewer/properties/brewed-coffees","value":"10"}
221221
```
222222

223-
In this scenario, connectivity service is used to create a ditto kafka connection, which reads messages from the provided topic, maps them to a ditto modify command and forwards it to things service. The things service then executes mongodb update query and generates the [thing modified event](protocol-specification-things-create-or-modify.html#event), which is pushed to the MMock service instance via an HTTP Push connection. Also, the kafka connection is configured with [qos=1](connectivity-protocol-bindings-kafka2.html#quality-of-service), which means if there is no acknowledgement that the thing is persisted, the operation will be retried.
223+
In this scenario, connectivity service is used to create a ditto kafka connection, which reads messages from the provided topic, maps them to a ditto modify command and forwards it to things service. The things service then executes mongodb update query and generates the [thing modified event](protocol-specification-things.html#create-or-modify-a-thing), which is pushed to the MMock service instance via an HTTP Push connection. Also, the kafka connection is configured with [qos=1](connectivity-protocol-bindings-kafka2.html#quality-of-service), which means if there is no acknowledgement that the thing is persisted, the operation will be retried.
224224

225225
The HTTP Push connection looks like the following:
226226

@@ -354,7 +354,7 @@ Scaling connectivity instance and changing our connection to have **clientCount*
354354

355355
### Device live messages(commands)
356356

357-
This scenario executes HTTP POST requests to ditto's [live channel](protocol-twinlive.html#live). An HTTP Push connection is subscribed for them and in turn pushes to a MMock instance that acts as a 'dummy' device receiver of live messages/commands and simply responds with pre-configured ditto response.
357+
This scenario executes HTTP POST requests to ditto's [live channel](protocol-twinlive.html#live-channel). An HTTP Push connection is subscribed for them and in turn pushes to a MMock instance that acts as a 'dummy' device receiver of live messages/commands and simply responds with pre-configured ditto response.
358358

359359
The HTTP POST request looks like the following:
360360

documentation/src/main/resources/openapi/ditto-api-2.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4247,7 +4247,7 @@ paths:
42474247
No special permission is required to issue a claim message.
42484248

42494249
### Example
4250-
See [Claiming](https://www.eclipse.dev/ditto/protocol-specification-things-messages.html#sending-and-handling-claim-messages) concept in detail and example in GitHub.
4250+
See [Claiming](https://www.eclipse.dev/ditto/protocol-specification-things-messages.html#claim-messages) concept in detail and example in GitHub.
42514251
However, in that scenario, the policy should grant you READ and WRITE permission on
42524252
the "message:/" resource in order to be able to send the message and read the response.
42534253
Further, the things-client which handles the "claim" message, needs permission to change the policy itself

documentation/src/main/resources/openapi/sources/paths/messages/inbox-claim.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ post:
3838
No special permission is required to issue a claim message.
3939
4040
### Example
41-
See [Claiming](https://www.eclipse.dev/ditto/protocol-specification-things-messages.html#sending-and-handling-claim-messages) concept in detail and example in GitHub.
41+
See [Claiming](https://www.eclipse.dev/ditto/protocol-specification-things-messages.html#claim-messages) concept in detail and example in GitHub.
4242
However, in that scenario, the policy should grant you READ and WRITE permission on
4343
the "message:/" resource in order to be able to send the message and read the response.
4444
Further, the things-client which handles the "claim" message, needs permission to change the policy itself

0 commit comments

Comments
 (0)