Merge branch 'main' into mw-article-tools-for-api-testing-2025

themattwilliams · web-flow · commit 419a09235b41 · 2025-08-19T13:35:03.000-05:00
diff --git a/docs/cli/@v2/changelog.md b/docs/cli/@v2/changelog.md
@@ -7,6 +7,16 @@ toc:
 
 <!-- do-not-remove -->
 
+## 2.0.6 (2025-08-19)
+
+### Patch Changes
+
+- Fixed an issue where files specified in decorators parameters were not always resolved correctly.
+  The resolution logic now properly locates the specified files relative to the config file for `info-description-override`, `media-type-examples-override`, `operation-description-override`, and `tag-description-override` decorators.
+- Improved messaging to clarify when API alias configuration is implicitly applied during linting or bundling by filename.
+- Updated the `retryAfter` property in Respect to use seconds (instead of milliseconds) for consistency with the Arazzo specification.
+- Updated @redocly/openapi-core to v2.0.6.
+
 ## 2.0.5 (2025-08-13)
 
 ### Patch Changes
diff --git a/docs/realm/changelogs.yaml b/docs/realm/changelogs.yaml
@@ -1,4 +1,15 @@
 '@redocly/realm':
+  0.125.0-next.4:
+    timestamp: 1755595996000
+    changes:
+      minor: []
+      patch: []
+    dependencies:
+      '@redocly/asyncapi-docs': 1.2.0-next.4
+      '@redocly/openapi-docs': 3.13.0-next.4
+      '@redocly/theme': 0.57.0-next.3
+      '@redocly/portal-plugin-mock-server': 0.10.0-next.4
+      '@redocly/graphql-docs': 1.2.0-next.0
   0.125.0-next.3:
     timestamp: 1755247386000
     changes:
@@ -4001,6 +4012,17 @@
       '@redocly/openapi-docs': 3.0.0-alpha.67
       '@redocly/portal-plugin-mock-server': 0.0.59
 '@redocly/reef':
+  0.125.0-next.4:
+    timestamp: 1755595996000
+    changes:
+      minor: []
+      patch: []
+    dependencies:
+      '@redocly/asyncapi-docs': 1.2.0-next.4
+      '@redocly/openapi-docs': 3.13.0-next.4
+      '@redocly/theme': 0.57.0-next.3
+      '@redocly/portal-plugin-mock-server': 0.10.0-next.4
+      '@redocly/graphql-docs': 1.2.0-next.0
   0.125.0-next.3:
     timestamp: 1755247386000
     changes:
@@ -7281,6 +7303,17 @@
     dependencies:
       '@redocly/portal-plugin-mock-server': 0.1.0
 '@redocly/revel':
+  0.125.0-next.4:
+    timestamp: 1755595996000
+    changes:
+      minor: []
+      patch: []
+    dependencies:
+      '@redocly/asyncapi-docs': 1.2.0-next.4
+      '@redocly/openapi-docs': 3.13.0-next.4
+      '@redocly/theme': 0.57.0-next.3
+      '@redocly/portal-plugin-mock-server': 0.10.0-next.4
+      '@redocly/graphql-docs': 1.2.0-next.0
   0.125.0-next.3:
     timestamp: 1755247386000
     changes:
@@ -10552,6 +10585,17 @@
     dependencies:
       '@redocly/portal-plugin-mock-server': 0.1.0
 '@redocly/redoc':
+  0.125.0-next.4:
+    timestamp: 1755595996000
+    changes:
+      minor: []
+      patch: []
+    dependencies:
+      '@redocly/asyncapi-docs': 1.2.0-next.4
+      '@redocly/openapi-docs': 3.13.0-next.4
+      '@redocly/theme': 0.57.0-next.3
+      '@redocly/portal-plugin-mock-server': 0.10.0-next.4
+      '@redocly/graphql-docs': 1.2.0-next.0
   0.125.0-next.3:
     timestamp: 1755247386000
     changes:
@@ -13824,6 +13868,13 @@
     dependencies:
       '@redocly/portal-plugin-mock-server': 0.1.0
 '@redocly/theme':
+  0.57.0-next.3:
+    timestamp: 1755595996000
+    changes:
+      minor: []
+      patch:
+        - Added Play and WorkflowHierarchy icons.
+    dependencies: {}
   0.57.0-next.2:
     timestamp: 1755247386000
     changes:
@@ -15952,6 +16003,14 @@
         - 'Improve "LastUpdated" component: support `format` and improve print styling'
     dependencies: {}
 '@redocly/openapi-docs':
+  3.13.0-next.4:
+    timestamp: 1755595996000
+    changes:
+      minor: []
+      patch:
+        - Added support for the `x-metadata` extension in AsyncAPI documentation.
+    dependencies:
+      '@redocly/replay': 0.16.0-next.3
   3.13.0-next.3:
     timestamp: 1755247386000
     changes:
@@ -19511,6 +19570,17 @@
       patch: []
     dependencies: {}
 '@redocly/portal-plugin-async-api':
+  1.8.0-next.4:
+    timestamp: 1755595996000
+    changes:
+      minor: []
+      patch: []
+    dependencies:
+      '@redocly/theme': 0.57.0-next.3
+      '@redocly/realm': 0.125.0-next.4
+      '@redocly/redoc': 0.125.0-next.4
+      '@redocly/redoc-reef': 0.125.0-next.4
+      '@redocly/redoc-revel': 0.125.0-next.4
   1.8.0-next.3:
     timestamp: 1755247386000
     changes:
@@ -23162,6 +23232,13 @@
     dependencies:
       '@redocly/portal': 0.26.0
 '@redocly/portal-plugin-mock-server':
+  0.10.0-next.4:
+    timestamp: 1755595996000
+    changes:
+      minor: []
+      patch: []
+    dependencies:
+      '@redocly/openapi-docs': 3.13.0-next.4
   0.10.0-next.3:
     timestamp: 1755247386000
     changes:
@@ -25197,6 +25274,16 @@
     dependencies:
       '@redocly/mock-server': 0.0.3
 '@redocly/replay':
+  0.16.0-next.3:
+    timestamp: 1755595996000
+    changes:
+      minor:
+        - >-
+          Added ability to run workflows, inputs schema for workflows, Arazzo expression highlighting and completion, support for x-security, updated
+          collection tree UI. Fixed binary, form-data file upload and digest auth flow.
+      patch: []
+    dependencies:
+      '@redocly/theme': 0.57.0-next.3
   0.16.0-next.2:
     timestamp: 1755247386000
     changes:
@@ -26342,6 +26429,13 @@
     dependencies:
       '@redocly/theme': 0.37.0
 '@redocly/theme-experimental':
+  0.8.0-next.3:
+    timestamp: 1755595996000
+    changes:
+      minor: []
+      patch: []
+    dependencies:
+      '@redocly/theme': 0.57.0-next.3
   0.8.0-next.2:
     timestamp: 1755247386000
     changes:
@@ -27468,6 +27562,15 @@
     dependencies:
       '@redocly/theme': 0.32.2
 '@redocly/asyncapi-docs':
+  1.2.0-next.4:
+    timestamp: 1755595996000
+    changes:
+      minor: []
+      patch:
+        - Added support for the `x-metadata` extension in AsyncAPI documentation.
+    dependencies:
+      '@redocly/openapi-docs': 3.13.0-next.4
+      '@redocly/theme': 0.57.0-next.3
   1.2.0-next.3:
     timestamp: 1755247386000
     changes:
@@ -29380,3 +29483,10 @@ reunite:
           Added a retention policy for project previews that deletes previews older than 90 days and removes previews on the same branch older than 5
           days, keeping only the latest.
     dependencies: {}
+  v2025-08-19.1:
+    timestamp: 1755563558000
+    changes:
+      minor:
+        - Posted pull request reviews to connected Git providers.
+      patch: []
+    dependencies: {}
diff --git a/docs/realm/content/api-docs/asyncapi-extensions/images/asyncapi-x-metadata.png b/docs/realm/content/api-docs/asyncapi-extensions/images/asyncapi-x-metadata.png
diff --git a/docs/realm/content/api-docs/asyncapi-extensions/index.md b/docs/realm/content/api-docs/asyncapi-extensions/index.md
@@ -9,6 +9,7 @@ The list of extensions supported in AsyncAPI by Redoc is as follows:
 - [x-enumDescriptions](./x-enum-descriptions.md) - Readable labels for enum values.
 - [x-rbac](x-rbac.md) - Control access to AsyncAPI objects.
 - [x-tagGroups](./x-tag-groups.md) - Higher-level grouping for tags, used in the sidebar.
+- [x-metadata](./x-metadata.md) - Add custom metadata at the top of the info section.
 
 ## Resources
 
diff --git a/docs/realm/content/api-docs/asyncapi-extensions/x-metadata.md b/docs/realm/content/api-docs/asyncapi-extensions/x-metadata.md
@@ -0,0 +1,73 @@
+# AsyncAPI extension: `x-metadata`
+
+Use `x-metadata` to add a table of additional data to the top of your API reference documentation.
+You can add any keys or values that you want users to easily find at the top level of the documentation.
+
+The data is formatted as a table and added as part of the description section at the top of the page.
+
+## Location
+
+The `x-metadata` extension can be added to Info Object.
+
+## Options
+
+{% table %}
+
+- Option
+- Type
+- Description
+
+---
+
+- x-metadata
+- Object
+- Custom metadata in key-value format.
+
+{% /table %}
+
+## Examples
+
+### `x-metadata` example
+
+Metadata keys can be any string.
+The values can be any primitive type, or a list of strings.
+
+The following is an example of an `x-metadata` section of an AsyncAPI description file:
+
+```yaml
+info:
+  x-metadata:
+    department: Technical shared services (East)
+    releaseDate: '12 Mar 2022'
+    authors:
+      - Sarah
+      - Soumya
+      - Susie
+```
+
+The data is presented as shown in the following screenshot:
+
+![title "Metadata" and a table showing the metadata](./images/asyncapi-x-metadata.png)
+
+### `x-metadata` as filters in classic catalog
+
+The following snippets are examples of `x-metadata` sections with configured `tags` you can use to [filter APIs in classic catalog](../../../config/catalog-classic.md#x-metadata-filters-in-classic-catalog).
+
+```yaml {% title="books-api.yaml" %}
+info:
+  x-metadata:
+    tags:
+      - Books
+```
+
+```yaml {% title="magazines-api.yaml" %}
+info:
+  x-metadata:
+    tags: ["Magazines"]
+```
+
+To use `tags` as filters, the values must be a list.
+
+## Resources
+
+- See a full [list of supported AsyncAPI extensions](./index.md).
diff --git a/docs/realm/sidebars.yaml b/docs/realm/sidebars.yaml
@@ -274,6 +274,8 @@
             label: x-additionalPropertiesName
           - page: content/api-docs/asyncapi-extensions/x-rbac.md
             label: x-rbac
+          - page: content/api-docs/asyncapi-extensions/x-metadata.md
+            label: x-metadata
         - page: content/api-docs/add-graphql-docs.md
           label: GraphQL
         - page: content/api-docs/add-soap-docs.md
