Skip to content

Commit 31ebfae

Browse files
committed
Updated tests to reflect addition of links and anchors to markdown output
1 parent 0261050 commit 31ebfae

File tree

6 files changed

+102
-65
lines changed

6 files changed

+102
-65
lines changed

doc-generator/tests/samples/generate_docs_cases/general/expected_output/markdown_output.md

Lines changed: 42 additions & 27 deletions
Large diffs are not rendered by default.

doc-generator/tests/samples/generate_docs_cases/general/expected_output/markdown_with_table_numbering_output.md

Lines changed: 42 additions & 27 deletions
Large diffs are not rendered by default.

doc-generator/tests/samples/generate_docs_cases/integer/expected_output/markdown_output.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
## IntegerTest 1.0.0
44

5+
<a name="integertest"></a>
56
### Description
67

78
This schema contains one or more properties of type integer.
@@ -18,5 +19,5 @@ This schema contains one or more properties of type integer.
1819
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**Count** | integer | *read-only<br>(null)* | The number of physical processors in the system. |
1920
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**LogicalProcessorCount** | integer | *read-only<br>(null)* | The number of logical processors in the system. |
2021
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**Model** | string | *read-only<br>(null)* | The processor model for the primary or majority of processors in this system. |
21-
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**Status** {} | object | | This type describes the status and health of a resource and its children. See the *Resource* schema for details on this property. |
22+
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**Status** {} | object | | This type describes the status and health of a resource and its children. See the *[Resource](http://redfish.dmtf.org/schemas/v1/Resource.json)* schema for details on this property. |
2223
| } | | |

doc-generator/tests/samples/generate_docs_cases/required/expected_output/markdown_output.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
## RequiredTest 1.0.0
44

5+
<a name="requiredtest"></a>
56
### Description
67

78
This schema contains required and requiredOnCreate properties.
@@ -12,11 +13,11 @@ This schema contains required and requiredOnCreate properties.
1213
|Property |Type |Attributes |Notes |
1314
| :--- | :--- | :--- | :--------------------- |
1415
| **Description** | string | *read-only<br>(null)* | Provides a description of this resource and is used for commonality in the schema definitions. |
15-
| **EntryType** | string<br>(enum) | *read-only required on create* | This is the type of log entry. *For the possible property values, see EntryType in Property details.* |
16+
| **EntryType** | string<br>(enum) | *read-only required on create* | This is the type of log entry. *For the possible property values, see [EntryType](#requiredtest-entrytype) in Property details.* |
1617
| **HostWatchdogTimer** { | object | | This object describes the Host Watchdog Timer functionality for this system. |
1718
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**FunctionEnabled** | boolean | *read-write required<br>(null)* | This indicates if the Host Watchdog Timer functionality has been enabled. Additional host-based software is necessary to activate the timer function. |
18-
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**Oem** {} | object | | Oem extension object. See the *Resource* schema for details on this property. |
19-
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**Status** {} | object | | This type describes the status and health of a resource and its children. See the *Resource* schema for details on this property. |
19+
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**Oem** {} | object | | Oem extension object. See the *[Resource](http://redfish.dmtf.org/schemas/v1/Resource.json)* schema for details on this property. |
20+
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**Status** {} | object | | This type describes the status and health of a resource and its children. See the *[Resource](http://redfish.dmtf.org/schemas/v1/Resource.json)* schema for details on this property. |
2021
| } | | |
2122
| **Id** | string | *read-only required* | Uniquely identifies the resource within the collection of like resources. |
2223
| **Name** | string | *read-only required* | The name of the resource or array element. |
@@ -25,6 +26,7 @@ This schema contains required and requiredOnCreate properties.
2526

2627
#### EntryType
2728

29+
<a name="requiredtest-entrytype"></a>
2830
This is the type of log entry.
2931

3032
| string | Description |

doc-generator/tests/samples/markdown_toc/input_blob.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,16 @@ A Network Device Function represents a logical interface exposed by the network
3131
| **AssignablePhysicalPorts** [ { | array | | The array of physical port references that this network device function may be assigned to. |
3232
| &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**@odata.id** | string<br>(URI) | *read-only* | The unique identifier for a resource. |
3333
| } ] | | |
34-
| **BootMode** | string<br>(enum) | *read-write<br>(null)* | The boot mode configured for this network device function. *For the possible property values, see BootMode in Property details.* |
34+
| **BootMode** | string<br>(enum) | *read-write<br>(null)* | The boot mode configured for this network device function. *For the possible property values, see [BootMode](#networkdevicefunction-bootmode) in Property details.* |
3535
| **Description** | string | *read-only<br>(null)* | Provides a description of this resource and is used for commonality in the schema definitions. |
3636
| **DeviceEnabled** | boolean | *read-write<br>(null)* | Whether the network device function is enabled. |
3737

3838
### Property details
3939

4040
#### AuthenticationMethod
4141

42+
<a name="networkdevicefunction-authenticationmethod"></a>
43+
4244
The iSCSI boot authentication method for this network device function.
4345

4446
| string | Description |
@@ -49,6 +51,8 @@ The iSCSI boot authentication method for this network device function.
4951

5052
#### BootMode
5153

54+
<a name="networkdevicefunction-bootmode"></a>
55+
5256
The boot mode configured for this network device function.
5357

5458
| string | Description |
@@ -87,6 +91,6 @@ A Network Port represents a discrete physical port capable of connecting to a ne
8791
|Property |Type |Attributes |Notes |
8892
| --- | --- | --- | --- |
8993
| **Actions** {} | object | | The available actions for this resource. |
90-
| **ActiveLinkTechnology** | string<br>(enum) | *read-write<br>(null)* | Network Port Active Link Technology. *For the possible property values, see ActiveLinkTechnology in Property details.* |
94+
| **ActiveLinkTechnology** | string<br>(enum) | *read-write<br>(null)* | Network Port Active Link Technology. *For the possible property values, see [ActiveLinkTechnology](#networkport-activelinktechnology) in Property details.* |
9195
| **AssociatedNetworkAddresses** [ ] | array (string, null) | *read-only* | The array of configured network addresses (MAC or WWN) that are associated with this Network Port, including the programmed address of the lowest numbered Network Device Function, the configured but not active address if applicable, the address for hardware port teaming, or other network addresses. |
9296
| **Description** | string | *read-only<br>(null)* | Provides a description of this resource and is used for commonality in the schem

doc-generator/tests/test_localized_schemas.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ def test_localized_schemas_default(mockRequest):
5252
# Descriptions
5353
'The ComputerSystem schema represents a computer or system instance',
5454
'The BootOptionReference of the Boot Option to perform a one-time boot from when BootSourceOverrideTarget is `UefiBootNext`.',
55-
'The name of the boot order property that the system uses for the persistent boot order. *For the possible property values, see BootOrderPropertySelection in Property details.*',
55+
'The name of the boot order property that the system uses for the persistent boot order. *For the possible property values, see [BootOrderPropertySelection](#computersystem-bootorderpropertyselection) in Property details.*',
5656
'| AliasBootOrder | The system uses the AliasBootOrder property to specify the persistent boot order. |',
5757
# enum that is annotated in the TEST locale (but not here):
5858
'| Continuous |',
@@ -88,7 +88,7 @@ def test_localized_schemas_normative_default(mockRequest):
8888
# Descriptions
8989
'This resource shall represent a computing system in the Redfish Specification.',
9090
'This property shall contain the BootOptionReference of the UEFI boot option for one time boot, as defined by the UEFI Specification. The valid values for this property are specified in the values of the BootOrder array.',
91-
'This property shall indicate which boot order property the system uses for the persistent boot order. *For the possible property values, see BootOrderPropertySelection in Property details.*',
91+
'This property shall indicate which boot order property the system uses for the persistent boot order. *For the possible property values, see [BootOrderPropertySelection](#computersystem-bootorderpropertyselection) in Property details.*',
9292
'| AliasBootOrder | The system uses the AliasBootOrder property to specify the persistent boot order. |',
9393
# enum that is annotated in the TEST locale (but not here):
9494
'| Continuous |',
@@ -124,7 +124,7 @@ def test_localized_schemas_TEST(mockRequest):
124124
# Examples of descriptions:
125125
'THE COMPUTERSYSTEM SCHEMA REPRESENTS A COMPUTER OR SYSTEM INSTANCE',
126126
'THE BOOTOPTIONREFERENCE OF THE BOOT OPTION TO PERFORM A ONE-TIME BOOT FROM WHEN BOOTSOURCEOVERRIDETARGET IS `UEFIBOOTNEXT`.',
127-
'THE NAME OF THE BOOT ORDER PROPERTY THAT THE SYSTEM USES FOR THE PERSISTENT BOOT ORDER. *FOR THE POSSIBLE PROPERTY VALUES, SEE BootOrderPropertySelection IN PROPERTY DETAILS.*',
127+
'THE NAME OF THE BOOT ORDER PROPERTY THAT THE SYSTEM USES FOR THE PERSISTENT BOOT ORDER. *FOR THE POSSIBLE PROPERTY VALUES, SEE [BootOrderPropertySelection](#computersystem-bootorderpropertyselection) IN PROPERTY DETAILS.*',
128128
'| AliasBootOrder | THE SYSTEM USES THE ALIASBOOTORDER PROPERTY TO SPECIFY THE PERSISTENT BOOT ORDER. |',
129129
]
130130

@@ -155,7 +155,7 @@ def test_localized_schemas_normative_TEST(mockRequest):
155155
# Descriptions
156156
'THIS RESOURCE SHALL REPRESENT A COMPUTING SYSTEM IN THE REDFISH SPECIFICATION.',
157157
'THIS PROPERTY SHALL CONTAIN THE BOOTOPTIONREFERENCE OF THE UEFI BOOT OPTION FOR ONE TIME BOOT, AS DEFINED BY THE UEFI SPECIFICATION. THE VALID VALUES FOR THIS PROPERTY ARE SPECIFIED IN THE VALUES OF THE BOOTORDER ARRAY.',
158-
'THIS PROPERTY SHALL INDICATE WHICH BOOT ORDER PROPERTY THE SYSTEM USES FOR THE PERSISTENT BOOT ORDER. *FOR THE POSSIBLE PROPERTY VALUES, SEE BootOrderPropertySelection IN PROPERTY DETAILS.*',
158+
'THIS PROPERTY SHALL INDICATE WHICH BOOT ORDER PROPERTY THE SYSTEM USES FOR THE PERSISTENT BOOT ORDER. *FOR THE POSSIBLE PROPERTY VALUES, SEE [BootOrderPropertySelection](#computersystem-bootorderpropertyselection) IN PROPERTY DETAILS.*',
159159
'| AliasBootOrder | THE SYSTEM USES THE ALIASBOOTORDER PROPERTY TO SPECIFY THE PERSISTENT BOOT ORDER. |',
160160
]
161161

@@ -184,7 +184,7 @@ def test_localized_schemas_en(mockRequest):
184184
# descriptions
185185
'The ComputerSystem schema represents a computer or system instance',
186186
'The BootOptionReference of the Boot Option to perform a one-time boot from when BootSourceOverrideTarget is `UefiBootNext`.',
187-
'The name of the boot order property that the system uses for the persistent boot order. *For the possible property values, see BootOrderPropertySelection in Property details.*',
187+
'The name of the boot order property that the system uses for the persistent boot order. *For the possible property values, see [BootOrderPropertySelection](#computersystem-bootorderpropertyselection) in Property details.*',
188188
'| AliasBootOrder | The system uses the AliasBootOrder property to specify the persistent boot order. |',
189189
# enum that is annotated in the TEST locale (but not here):
190190
'| Continuous |',

0 commit comments

Comments
 (0)