Skip to content

Commit

Permalink
lint fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
W-A-James committed Mar 25, 2024
1 parent 3863396 commit 16744ba
Showing 1 changed file with 17 additions and 15 deletions.
32 changes: 17 additions & 15 deletions source/unified-test-format/unified-test-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -1162,28 +1162,30 @@ The structure of this object is as follows:

<span id="expectedEvent_topologyDescriptionChangedEvent" />

- `topologyDescriptionChangedEvent`: Optional object. Assertions for one
- `topologyDescriptionChangedEvent`: Optional object. Assertions for one
[TopologyDescriptionChangedEvent](../server-discovery-and-monitoring/server-discovery-and-monitoring-logging-and-monitoring.rst#events)
object.

The structure of this object is as follows:

- `previousDescription`: Optional Object. A value corresponding to the topology description as it
was before the change that triggered the event.
- `newDescription` : Optional Object. A value corresponding to the topology description as it
is after the change that triggered the event.
- `previousDescription`: Optional Object. A value corresponding to the topology description as it was before the
change that triggered the event.

Test runners SHOULD ignore any other fields than the `previousDescription` and `newDescription`
fields.
- `newDescription` : Optional Object. A value corresponding to the topology description as it is after the change that
triggered the event.

The structure of a topology description object (which the `previousDescription` and
`newDescription` fields contain is as follows:
Test runners SHOULD ignore any other fields than the `previousDescription` and `newDescription` fields.

- `type`: Optional string. The type of the topology in the description. Test runners MUST assert
that the type in the published event matches this value. See [SDAM: TopologyType](../server-discovery-and-monitoring/server-discovery-and-monitoring.rst#topologytype) for a list of valid values.
The structure of a topology description object (which the `previousDescription` and `newDescription` fields contain
is as follows:

Test runners SHOULD ignore any other fields present on the `previousDescription` and
`newDescription` fields of the captured `topologyDescriptionChangedEvent`.
- `type`: Optional string. The type of the topology in the description. Test runners MUST assert that the type in
the published event matches this value. See
[SDAM: TopologyType](../server-discovery-and-monitoring/server-discovery-and-monitoring.rst#topologytype) for a
list of valid values.

Test runners SHOULD ignore any other fields present on the `previousDescription` and `newDescription` fields of the
captured `topologyDescriptionChangedEvent`.

##### hasServiceId

Expand Down Expand Up @@ -3414,8 +3416,8 @@ other specs *and* collating spec changes developed in parallel or during the sam
## Changelog

- 2024-03-25: **Schema version 1.20.**\
Add `previousDescription` and `newDescription` assertions to `topologyDescriptionChangedEvent`
when checking events with `expectEvents`
Add `previousDescription` and `newDescription` assertions to
`topologyDescriptionChangedEvent` when checking events with `expectEvents`

- 2024-03-11: Note that `killAllSessions` should not be executed on Atlas Data Lake

Expand Down

0 comments on commit 16744ba

Please sign in to comment.