@redocly/realm 0.137.0-next.3 → 0.137.0-next.5

package/CHANGELOG.md

@@ -1,5 +1,56 @@
 # @redocly/realm
 
+## 0.137.0-next.5
+
+### Patch Changes
+
+- 4925ce16bea: Fixed an issue in API docs where a schema that inherited its `discriminator` from an `allOf` parent displayed only the discriminator property, without its variants or other properties.
+- 4925ce16bea: Fixed an issue where a variant whose schema was unavailable, such as a schema restricted by RBAC, displayed as an empty option.
+- bff49e7278f: Fixed an issue in OpenAPI docs where selecting an example in the response panel did not update the request code sample.
+  The issue occurred when request and response examples shared the same key.
+- ac184788d19: Fixed an issue where angle brackets: `<`, `>` weren't rendered inside inline code within Markdown link text, such as `` [`command <name>`](./page.md) ``.
+- 67c2f278ff4: Fixed an issue where example descriptions weren't rendered in the request and response samples panels.
+  Descriptions render as Markdown below the example selector for all languages and include callback payloads and descriptions pre-parsed by the portal.
+- 4925ce16bea: Fixed an issue where code samples omitted the discriminator value of the selected variant.
+- bf3aa0200bf: Improved sidebar accessibility: separators are no longer announced as links by screen readers and no longer receive keyboard focus.
+- 505de02f7b8: Fixed an issue where a search query that contained double characters returned an error.
+- 4925ce16bea: Fixed an issue where a mapping key that pointed to the same schema as `defaultMapping` disappeared from the variant list.
+- 4925ce16bea: Fixed an issue in API docs where the code samples panel displayed no `Discriminator` selector for schemas that inherit their `discriminator` from an `allOf` parent.
+- Updated dependencies [4925ce16bea]
+- Updated dependencies [4925ce16bea]
+- Updated dependencies [bff49e7278f]
+- Updated dependencies [67c2f278ff4]
+- Updated dependencies [4925ce16bea]
+- Updated dependencies [bf3aa0200bf]
+- Updated dependencies [4925ce16bea]
+- Updated dependencies [4925ce16bea]
+  - @redocly/api-docs@0.2.0-next.5
+  - @redocly/theme@0.69.0-next.5
+  - @redocly/asyncapi-docs@1.14.0-next.5
+  - @redocly/graphql-docs@1.14.0-next.5
+  - @redocly/openapi-docs@3.25.0-next.5
+  - @redocly/portal-plugin-mock-server@0.22.0-next.5
+
+## 0.137.0-next.4
+
+### Patch Changes
+
+- 34e13e3c9e1: Fixed OAuth2 client credentials exchange in the MCP gateway credentials form.
+- 772bee46a31: The MCP credentials page consolidated all accepted API credentials on one page.
+- f53b16a05de: Updated the MCP API-credentials page to match Redocly styling.
+- 02b5b225d9d: Fixed build and Webview preview failures caused by missing exports in `@xyflow/system`.
+- 109fd55824b: Updated `@redocly/openapi-core` to version `2.47.0`.
+- 5b825b1f1fe: Fixed an issue in OpenAPI docs where the server URL was missing from the request panel for APIs with a single server when the mock server was disabled.
+- Updated dependencies [02b5b225d9d]
+- Updated dependencies [109fd55824b]
+- Updated dependencies [5b825b1f1fe]
+  - @redocly/theme@0.69.0-next.4
+  - @redocly/api-docs@0.2.0-next.4
+  - @redocly/openapi-docs@3.25.0-next.4
+  - @redocly/asyncapi-docs@1.14.0-next.4
+  - @redocly/graphql-docs@1.14.0-next.4
+  - @redocly/portal-plugin-mock-server@0.22.0-next.4
+
 ## 0.137.0-next.3
 
 ### Minor Changes
@@ -104,6 +155,19 @@
   - @redocly/graphql-docs@1.14.0-next.0
   - @redocly/portal-plugin-mock-server@0.22.0-next.0
 
+## 0.136.2
+
+### Patch Changes
+
+- 7b45d118926: Fixed build and Webview preview failures caused by missing exports in `@xyflow/system`.
+- Updated dependencies [7b45d118926]
+  - @redocly/theme@0.68.2
+  - @redocly/api-docs@0.1.2
+  - @redocly/asyncapi-docs@1.13.2
+  - @redocly/graphql-docs@1.13.2
+  - @redocly/openapi-docs@3.24.2
+  - @redocly/portal-plugin-mock-server@0.21.2
+
 ## 0.136.1
 
 ### Patch Changes

package/dist/cli/stats/collectors/openapi/index.js

@@ -1 +1 @@
-import{detectSpec as u,getTypes as d,normalizeTypes as h,normalizeVisitors as w,resolveDocument as y,BaseResolver as D,StatsOAS as S,walkDocument as g}from"@redocly/openapi-core";import{logger as m}from"../../../../server/tools/notifiers/logger.js";import{envConfig as I}from"../../../../server/config/env-config.js";import{telemetryTraceStep as O}from"../../../telemetry/helpers/trace-step.js";import{telemetry as b}from"../../../telemetry/index.js";import{computeOas32Stats as v}from"./oas32.js";const t={refs:{metric:"References",total:0,color:"red",items:new Set},externalDocs:{metric:"External Documents",total:0,color:"magenta"},schemas:{metric:"Schemas",total:0,color:"white"},parameters:{metric:"Parameters",total:0,color:"yellow",items:new Set},links:{metric:"Links",total:0,color:"cyan",items:new Set},pathItems:{metric:"Path Items",total:0,color:"green"},webhooks:{metric:"Webhooks",total:0,color:"green"},operations:{metric:"Operations",total:0,color:"yellow"},tags:{metric:"Tags",total:0,color:"white",items:new Set}};async function _(n,s){await O("com.redocly.stats.openapi",async()=>{m.info("OpenAPI collector: start processing documents...");const e=(await n.cache.load(".","api-docs")).data,a=[];for(const r of e){if(r.type!=="openapi"||r.isVirtual)continue;const o=await k(r);a.push(o),b.sendStatsOpenapiCollectedMessage([{id:o.path,object:"openapiDefinition",uri:`urn:redocly:realm:cli:openapiDefinition:${o.path}`,...o,projectBuildId:I.PROJECT_BUILD_ID||""}])}s||console.table(a),m.info("OpenAPI collector: openapi documents processing completed.")})}async function k(n){const s=n.document,e=u(s),a=h(d(e)),r=w([{severity:"warn",ruleId:"openapi_stats",visitor:S(t)}],a),o={problems:[],specVersion:e,visitorsData:{}},c={source:{absoluteRef:""},parsed:s},i=a.Root;if(!i)throw new Error("Root type not found in OpenAPI spec types");const f=await y({rootDocument:c,rootType:i,externalRefResolver:new D});g({rootType:i,normalizedVisitors:r,resolvedRefMap:f,document:c,ctx:o});const l={path:n.relativePath,refs:t.refs.total,externalDocs:t.externalDocs.total,schemas:t.schemas.total,parameters:t.parameters.total,links:t.links.total,pathItems:t.pathItems.total,webhooks:t.webhooks.total,operations:t.operations.total,tags:t.tags.total,version:e};if(e==="oas3_2"){const p=v(s);p&&Object.assign(l,p)}return l}export{_ as collectOpenapiDocumentsStatistics};
+import{detectSpec as u,getTypes as d,normalizeTypes as h,normalizeVisitors as w,resolveDocument as y,BaseResolver as D,StatsOAS as S,walkDocument as g}from"@redocly/openapi-core";import{logger as m}from"../../../../server/tools/notifiers/logger.js";import{envConfig as I}from"../../../../server/config/env-config.js";import{telemetryTraceStep as O}from"../../../telemetry/helpers/trace-step.js";import{telemetry as b}from"../../../telemetry/index.js";import{computeOas32Stats as v}from"./oas32.js";const t={refs:{metric:"References",total:0,color:"red",items:new Set},externalDocs:{metric:"External Documents",total:0,color:"magenta"},schemas:{metric:"Schemas",total:0,color:"white"},parameters:{metric:"Parameters",total:0,color:"yellow",items:new Set},links:{metric:"Links",total:0,color:"cyan",items:new Set},pathItems:{metric:"Path Items",total:0,color:"green"},webhooks:{metric:"Webhooks",total:0,color:"green"},operations:{metric:"Operations",total:0,color:"yellow"},tags:{metric:"Tags",total:0,color:"white",items:new Set},xExtensions:{metric:"Vendor Extensions",total:0,color:"cyan",counts:{}}};async function E(r,s){await O("com.redocly.stats.openapi",async()=>{m.info("OpenAPI collector: start processing documents...");const e=(await r.cache.load(".","api-docs")).data,a=[];for(const n of e){if(n.type!=="openapi"||n.isVirtual)continue;const o=await x(n);a.push(o),b.sendStatsOpenapiCollectedMessage([{id:o.path,object:"openapiDefinition",uri:`urn:redocly:realm:cli:openapiDefinition:${o.path}`,...o,projectBuildId:I.PROJECT_BUILD_ID||""}])}s||console.table(a),m.info("OpenAPI collector: openapi documents processing completed.")})}async function x(r){const s=r.document,e=u(s),a=h(d(e)),n=w([{severity:"warn",ruleId:"openapi_stats",visitor:S(t)}],a),o={problems:[],specVersion:e,visitorsData:{}},c={source:{absoluteRef:""},parsed:s},i=a.Root;if(!i)throw new Error("Root type not found in OpenAPI spec types");const f=await y({rootDocument:c,rootType:i,externalRefResolver:new D});g({rootType:i,normalizedVisitors:n,resolvedRefMap:f,document:c,ctx:o});const l={path:r.relativePath,refs:t.refs.total,externalDocs:t.externalDocs.total,schemas:t.schemas.total,parameters:t.parameters.total,links:t.links.total,pathItems:t.pathItems.total,webhooks:t.webhooks.total,operations:t.operations.total,tags:t.tags.total,version:e};if(e==="oas3_2"){const p=v(s);p&&Object.assign(l,p)}return l}export{E as collectOpenapiDocumentsStatistics};

package/dist/client/app/markdoc/custom-components/openapi/json-schema.js

@@ -1 +1 @@
-import{MarkdownAdapterProvider as l,RedocSchema as h,StoreProvider as f,createMarkdocAdapter as k,markdocParser as u}from"@redocly/api-docs";import*as e from"react";import{Admonition as E}from"@redocly/theme/markdoc/components/Admonition/Admonition";import{MarkdownLink as v}from"@redocly/theme/markdoc/components/MarkdownLink/MarkdownLink";import{link as A}from"../../../../../markdoc/nodes/index.js";import{OpenApiComponentWrap as P}from"../styled.elements";const a={nodes:{link:A},components:{MarkdownLink:v}};function S(m){const{options:s,title:t,schemaResolved:o,schemaResolvedErrors:n,schema:r}=m,i=e.useMemo(()=>k(a),[]);if(r||o){const c={openapi:"3.0.0",info:{version:"1",description:"test",title:"test"},paths:{},"x-root":o?.components?.schemas?.__root||r,components:{schemas:{...o?.components?.schemas}}};return e.createElement(P,{"data-testid":"json-schema"},t?e.createElement("h3",null,t):null,e.createElement(f,{options:{...s,markdocOptions:a,markdownParser:u},definition:c},e.createElement(l,{value:i},n?.length?e.createElement(E,{name:"Problem in json-schema tag",type:"danger"},n.map((p,d)=>e.createElement("div",{key:d},p))):null,e.createElement(h,{pointer:"#/x-root",disableDeepLinks:!0}))))}}export{S as JsonSchema};
+import{MarkdownAdapterProvider as d,RedocSchema as l,StoreProvider as h,markdocParser as f}from"@redocly/api-docs";import*as e from"react";import{Admonition as k}from"@redocly/theme/markdoc/components/Admonition/Admonition";import{OpenApiComponentWrap as u}from"../styled.elements";import{markdocOptions as E,usePortalMarkdownAdapter as v}from"./use-markdown-adapter";function g(a){const{options:m,title:o,schemaResolved:t,schemaResolvedErrors:r,schema:n}=a,s=v();if(n||t){const i={openapi:"3.0.0",info:{version:"1",description:"test",title:"test"},paths:{},"x-root":t?.components?.schemas?.__root||n,components:{schemas:{...t?.components?.schemas}}};return e.createElement(u,{"data-testid":"json-schema"},o?e.createElement("h3",null,o):null,e.createElement(h,{options:{...m,markdocOptions:E,markdownParser:f},definition:i},e.createElement(d,{value:s},r?.length?e.createElement(k,{name:"Problem in json-schema tag",type:"danger"},r.map((c,p)=>e.createElement("div",{key:p},c))):null,e.createElement(l,{pointer:"#/x-root",disableDeepLinks:!0}))))}}export{g as JsonSchema};

package/dist/client/app/markdoc/custom-components/openapi/openapi-code-sample.js

@@ -1 +1 @@
-import*as o from"react";import{StoreProvider as h,RedocCodeSample as k,appendUndeclaredConfigureParameters as C,excludeMockServers as i,markdocParser as E}from"@redocly/api-docs";import{ErrorMessage as P,OpenApiComponentWrap as q}from"../styled.elements";import{useStore as x}from"../../hooks/use-store";import{findCodeSamplePanel as I}from"../../utils/find-code-sample-panel.js";function B(m){const{descriptionFile:d,operationId:s,pointer:a,exampleKey:c,mimeType:u,language:t,requestBody:l,parameters:e,environment:f,environments:v}=m,{store:r,error:y}=x(d),g=o.useMemo(()=>({specType:"openapi",...r?.options,...t&&{codeSamples:{languages:[{lang:t??""}]}},markdownParser:E}),[t,r?.options]),p=o.useMemo(()=>{if(!r?.items?.length)return;const n=I(r.items,{pointer:a,sourceId:s});if(!n)return;const S=C({...n.source,servers:i(n.source.servers)},{...e?.path&&{path:e.path},...e?.query&&{query:e.query},...e?.header&&{headers:e.header},...e?.cookie&&{cookie:e.cookie}});return{...n,...n.servers&&{servers:i(n.servers)},source:S}},[r?.items,a,s,e]);return r?p?o.createElement(q,{"data-testid":"openapi-code-sample"},o.createElement(h,{options:g,apiStore:r.store},o.createElement(k,{node:p,mimeType:u,exampleKey:c,requestBody:l,parameters:e,environment:f,environments:v}))):o.createElement("pre",{style:{color:"red"}},"Cannot find OpenAPI operation (use pointer or operationId)"):o.createElement(P,null,y)}export{B as OpenApiCodeSample};
+import*as r from"react";import{MarkdownAdapterProvider as P,StoreProvider as h,RedocCodeSample as E,appendUndeclaredConfigureParameters as A,excludeMockServers as i,markdocParser as C}from"@redocly/api-docs";import{ErrorMessage as M,OpenApiComponentWrap as q}from"../styled.elements";import{useStore as w}from"../../hooks/use-store";import{findCodeSamplePanel as x}from"../../utils/find-code-sample-panel.js";import{usePortalMarkdownAdapter as I}from"./use-markdown-adapter";function F(m){const{descriptionFile:d,operationId:a,pointer:s,exampleKey:c,mimeType:u,language:n,requestBody:l,parameters:e,environment:f,environments:v}=m,{store:o,error:y}=w(d),g=I(),k=r.useMemo(()=>({specType:"openapi",...o?.options,...n&&{codeSamples:{languages:[{lang:n??""}]}},markdownParser:C}),[n,o?.options]),p=r.useMemo(()=>{if(!o?.items?.length)return;const t=x(o.items,{pointer:s,sourceId:a});if(!t)return;const S=A({...t.source,servers:i(t.source.servers)},{...e?.path&&{path:e.path},...e?.query&&{query:e.query},...e?.header&&{headers:e.header},...e?.cookie&&{cookie:e.cookie}});return{...t,...t.servers&&{servers:i(t.servers)},source:S}},[o?.items,s,a,e]);return o?p?r.createElement(q,{"data-testid":"openapi-code-sample"},r.createElement(h,{options:k,apiStore:o.store},r.createElement(P,{value:g},r.createElement(E,{node:p,mimeType:u,exampleKey:c,requestBody:l,parameters:e,environment:f,environments:v})))):r.createElement("pre",{style:{color:"red"}},"Cannot find OpenAPI operation (use pointer or operationId)"):r.createElement(M,null,y)}export{F as OpenApiCodeSample};

package/dist/client/app/markdoc/custom-components/openapi/openapi-example.js

@@ -1 +1 @@
-import*as e from"react";import{RedocExample as m,StoreProvider as s,markdocParser as c}from"@redocly/api-docs";import{ErrorMessage as l,OpenApiComponentWrap as d}from"../styled.elements";import{useStore as E}from"../../hooks/use-store";function y(o){const{descriptionFile:t,pointer:p,options:n,mimeType:i}=o,{store:r,error:a}=E(t);return r?e.createElement(d,{"data-testid":"openapi-example"},e.createElement(s,{options:{specType:"openapi",...r.options,...n,markdownParser:c},apiStore:r.store},e.createElement(m,{pointer:p,mimeType:i||"application/json"}))):e.createElement(l,null,a)}export{y as OpenApiExample};
+import*as e from"react";import{MarkdownAdapterProvider as s,RedocExample as c,StoreProvider as d,markdocParser as l}from"@redocly/api-docs";import{ErrorMessage as E,OpenApiComponentWrap as f}from"../styled.elements";import{useStore as u}from"../../hooks/use-store";import{usePortalMarkdownAdapter as k}from"./use-markdown-adapter";function v(o){const{descriptionFile:t,pointer:p,options:a,mimeType:n}=o,{store:r,error:i}=u(t),m=k();return r?e.createElement(f,{"data-testid":"openapi-example"},e.createElement(d,{options:{specType:"openapi",...r.options,...a,markdownParser:l},apiStore:r.store},e.createElement(s,{value:m},e.createElement(c,{pointer:p,mimeType:n||"application/json"})))):e.createElement(E,null,i)}export{v as OpenApiExample};

package/dist/client/app/markdoc/custom-components/openapi/openapi-response-sample.js

@@ -1 +1 @@
-import*as o from"react";import{StoreProvider as l,RedocResponseSamples as d,markdocParser as c}from"@redocly/api-docs";import{ErrorMessage as n,OpenApiComponentWrap as f}from"../styled.elements";import{useStore as u}from"../../hooks/use-store";import{findResponseSamples as S}from"../../utils/find-openapi-response-samples.js";function g(s){const{descriptionFile:t,operationId:p,pointer:a,exampleKey:i}=s,{store:e,error:m}=u(t);if(!e)return o.createElement(n,null,m);const r=e.items?.length?S(e.items,{pointer:a,sourceId:p}):void 0;return r?.responseCodes.length?o.createElement(f,{"data-testid":"openapi-response-sample"},o.createElement(l,{options:{...e.options,specType:"openapi",markdownParser:c},apiStore:e.store},o.createElement(d,{responseCodes:r.responseCodes,exampleKey:i,schemaId:r.schemaId}))):o.createElement(n,null,"Cannot find response samples for the given operation")}export{g as OpenApiResponseSample};
+import*as e from"react";import{MarkdownAdapterProvider as l,RedocResponseSamples as c,StoreProvider as f,markdocParser as u}from"@redocly/api-docs";import{ErrorMessage as t,OpenApiComponentWrap as E}from"../styled.elements";import{useStore as S}from"../../hooks/use-store";import{findResponseSamples as P}from"../../utils/find-openapi-response-samples.js";import{usePortalMarkdownAdapter as h}from"./use-markdown-adapter";function v(n){const{descriptionFile:s,operationId:p,pointer:a,exampleKey:m}=n,{store:r,error:i}=S(s),d=h();if(!r)return e.createElement(t,null,i);const o=r.items?.length?P(r.items,{pointer:a,sourceId:p}):void 0;return o?.responseCodes.length?e.createElement(E,{"data-testid":"openapi-response-sample"},e.createElement(f,{options:{...r.options,specType:"openapi",markdownParser:u},apiStore:r.store},e.createElement(l,{value:d},e.createElement(c,{responseCodes:o.responseCodes,exampleKey:m,schemaId:o.schemaId})))):e.createElement(t,null,"Cannot find response samples for the given operation")}export{v as OpenApiResponseSample};

package/dist/client/app/markdoc/custom-components/openapi/use-markdown-adapter.d.ts

@@ -0,0 +1,45 @@
+import type { MarkdownAdapter } from '@redocly/api-docs';
+import { MarkdownLink } from '@redocly/theme/markdoc/components/MarkdownLink/MarkdownLink';
+/** Routes description links through portal `Link` (path prefix, locale, etc.). */
+export declare const markdocOptions: {
+    nodes: {
+        link: {
+            attributes?: Record<string, import("@markdoc/markdoc").SchemaAttribute>;
+            slots?: Record<string, import("@markdoc/markdoc").SchemaSlot>;
+            selfClosing?: boolean;
+            inline?: boolean;
+            transform?(node: import("@markdoc/markdoc").Node, config: Readonly<Partial<{
+                nodes: Partial<Record<import("@markdoc/markdoc").NodeType, import("@markdoc/markdoc").Schema<Partial</*elided*/ any>, string>>>;
+                tags: Record<string, import("@markdoc/markdoc").Schema>;
+                variables: Record<string, any>;
+                functions: Record<string, import("@markdoc/markdoc").ConfigFunction>;
+                partials: Record<string, any>;
+                validation?: {
+                    parents?: import("@markdoc/markdoc").Node[];
+                    validateFunctions?: boolean;
+                    environment?: string;
+                };
+            }>>): import("@markdoc/markdoc").MaybePromise<import("@markdoc/markdoc").RenderableTreeNodes>;
+            validate?(node: import("@markdoc/markdoc").Node, config: Readonly<Partial<{
+                nodes: Partial<Record<import("@markdoc/markdoc").NodeType, import("@markdoc/markdoc").Schema<Partial</*elided*/ any>, string>>>;
+                tags: Record<string, import("@markdoc/markdoc").Schema>;
+                variables: Record<string, any>;
+                functions: Record<string, import("@markdoc/markdoc").ConfigFunction>;
+                partials: Record<string, any>;
+                validation?: {
+                    parents?: import("@markdoc/markdoc").Node[];
+                    validateFunctions?: boolean;
+                    environment?: string;
+                };
+            }>>): import("@markdoc/markdoc").MaybePromise<import("@markdoc/markdoc").ValidationError[]>;
+            description?: string;
+            render: string;
+            children: string[];
+        };
+    };
+    components: {
+        MarkdownLink: typeof MarkdownLink;
+    };
+};
+export declare function usePortalMarkdownAdapter(): MarkdownAdapter;
+//# sourceMappingURL=use-markdown-adapter.d.ts.map

package/dist/client/app/markdoc/custom-components/openapi/use-markdown-adapter.js

@@ -0,0 +1 @@
+import*as o from"react";import{createMarkdocAdapter as r}from"@redocly/api-docs";import{MarkdownLink as t}from"@redocly/theme/markdoc/components/MarkdownLink/MarkdownLink";import{link as e}from"../../../../../markdoc/nodes/index.js";const n={nodes:{link:e},components:{MarkdownLink:t}};function i(){return o.useMemo(()=>r(n),[])}export{n as markdocOptions,i as usePortalMarkdownAdapter};

package/dist/client/utils/catalog/get-next-page-param.d.ts

@@ -3,6 +3,6 @@ export type PaginatedResponse = {
     page: Page;
 };
 export declare function getNextPageParam<T extends PaginatedResponse>(lastPage: T): {
-    after: string | null;
+    after: string;
 } | undefined;
 //# sourceMappingURL=get-next-page-param.d.ts.map

package/dist/client/utils/catalog/get-next-page-param.js

@@ -1 +1 @@
-function r(e){return e?.page?.hasNextPage?{after:e?.page?.endCursor}:void 0}export{r as getNextPageParam};
+function n(e){return e?.page?.nextPage?{after:e.page.nextPage}:void 0}export{n as getNextPageParam};