Skip to content

Commit 6d260ec

Browse files
fix: escape curly braces in MDX headings to prevent JSX evaluation (#70)
Wrap API path headings in backticks so MDX does not interpret {namespace} and {name} as JavaScript expressions. Closes #69 Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 6a493b1 commit 6d260ec

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/01-validation-report.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This project validates F5 XC OpenAPI specifications against the live API, identi
1919

2020
## Modifications by File
2121

22-
### /api/config/namespaces/{namespace}/api_definitions/{name}
22+
### `/api/config/namespaces/{namespace}/api_definitions/{name}`
2323

2424
| Property | Constraint | Type | Spec Value | API Behavior |
2525
|----------|------------|------|------------|--------------|
@@ -44,7 +44,7 @@ This project validates F5 XC OpenAPI specifications against the live API, identi
4444
| `response_schema` | `schema_validation` | **Mismatch** | `Valid per OpenAPI schema` | Undocumented Content-Type<br/><br/>Received: text/plain<br/>Documented: application/json |
4545
| `response_schema` | `schema_validation` | **Mismatch** | `Valid per OpenAPI schema` | Undocumented Content-Type<br/><br/>Received: text/plain<br/>Documented: application/json |
4646

47-
### /api/config/namespaces/{namespace}/api_discoverys/{name}
47+
### `/api/config/namespaces/{namespace}/api_discoverys/{name}`
4848

4949
| Property | Constraint | Type | Spec Value | API Behavior |
5050
|----------|------------|------|------------|--------------|
@@ -69,7 +69,7 @@ This project validates F5 XC OpenAPI specifications against the live API, identi
6969
| `response_schema` | `schema_validation` | **Mismatch** | `Valid per OpenAPI schema` | Undocumented Content-Type<br/><br/>Received: text/plain<br/>Documented: application/json |
7070
| `response_schema` | `schema_validation` | **Mismatch** | `Valid per OpenAPI schema` | Undocumented Content-Type<br/><br/>Received: text/plain<br/>Documented: application/json |
7171

72-
### /api/config/namespaces/{namespace}/app_firewalls/{name}
72+
### `/api/config/namespaces/{namespace}/app_firewalls/{name}`
7373

7474
| Property | Constraint | Type | Spec Value | API Behavior |
7575
|----------|------------|------|------------|--------------|
@@ -94,7 +94,7 @@ This project validates F5 XC OpenAPI specifications against the live API, identi
9494
| `response_schema` | `schema_validation` | **Mismatch** | `Valid per OpenAPI schema` | Undocumented Content-Type<br/><br/>Received: text/plain<br/>Documented: application/json |
9595
| `response_schema` | `schema_validation` | **Mismatch** | `Valid per OpenAPI schema` | Undocumented Content-Type<br/><br/>Received: text/plain<br/>Documented: application/json |
9696

97-
### /api/config/namespaces/{namespace}/code_base_integrations/{name}
97+
### `/api/config/namespaces/{namespace}/code_base_integrations/{name}`
9898

9999
| Property | Constraint | Type | Spec Value | API Behavior |
100100
|----------|------------|------|------------|--------------|
@@ -119,7 +119,7 @@ This project validates F5 XC OpenAPI specifications against the live API, identi
119119
| `response_schema` | `schema_validation` | **Mismatch** | `Valid per OpenAPI schema` | Undocumented Content-Type<br/><br/>Received: text/plain<br/>Documented: application/json |
120120
| `response_schema` | `schema_validation` | **Mismatch** | `Valid per OpenAPI schema` | Undocumented Content-Type<br/><br/>Received: text/plain<br/>Documented: application/json |
121121

122-
### /api/config/namespaces/{namespace}/data_types/{name}
122+
### `/api/config/namespaces/{namespace}/data_types/{name}`
123123

124124
| Property | Constraint | Type | Spec Value | API Behavior |
125125
|----------|------------|------|------------|--------------|
@@ -144,7 +144,7 @@ This project validates F5 XC OpenAPI specifications against the live API, identi
144144
| `response_schema` | `schema_validation` | **Mismatch** | `Valid per OpenAPI schema` | Undocumented Content-Type<br/><br/>Received: text/plain<br/>Documented: application/json |
145145
| `response_schema` | `schema_validation` | **Mismatch** | `Valid per OpenAPI schema` | Undocumented Content-Type<br/><br/>Received: text/plain<br/>Documented: application/json |
146146

147-
### /api/config/namespaces/{namespace}/sensitive_data_policys/{name}
147+
### `/api/config/namespaces/{namespace}/sensitive_data_policys/{name}`
148148

149149
| Property | Constraint | Type | Spec Value | API Behavior |
150150
|----------|------------|------|------------|--------------|
@@ -169,7 +169,7 @@ This project validates F5 XC OpenAPI specifications against the live API, identi
169169
| `response_schema` | `schema_validation` | **Mismatch** | `Valid per OpenAPI schema` | Undocumented Content-Type<br/><br/>Received: text/plain<br/>Documented: application/json |
170170
| `response_schema` | `schema_validation` | **Mismatch** | `Valid per OpenAPI schema` | Undocumented Content-Type<br/><br/>Received: text/plain<br/>Documented: application/json |
171171

172-
### /api/web/namespaces/{namespace}/api_groups/{name}
172+
### `/api/web/namespaces/{namespace}/api_groups/{name}`
173173

174174
| Property | Constraint | Type | Spec Value | API Behavior |
175175
|----------|------------|------|------------|--------------|

0 commit comments

Comments
 (0)