docs(api): extract repeated alias structures into params.md mixins#40654
Open
pavelfeldman wants to merge 1 commit intomicrosoft:mainfrom
Open
docs(api): extract repeated alias structures into params.md mixins#40654pavelfeldman wants to merge 1 commit intomicrosoft:mainfrom
pavelfeldman wants to merge 1 commit intomicrosoft:mainfrom
Conversation
Several object-type structures with identical sub-fields and identical language aliases were duplicated across class docs. Extract them as mixins in `params.md`: - `return-headers-array` (csharp:Header, java:HttpHeader) used by APIResponse.headersArray, Request.headersArray, Response.headersArray - `expose-binding-callback` (java:BindingCallback) used by BrowserContext.exposeBinding, Page.exposeBinding - `expose-function-callback` (java:FunctionCallback) used by BrowserContext.exposeFunction, Page.exposeFunction - `file-payload-fields` (csharp:FilePayload, java:FilePayload) used by FormData.append.value (default+csharp), FormData.set.value (default+csharp), and the existing input-files mixin To support nested-struct extraction (FilePayload lives inside another type's `value` parameter), extend the mixin substitution in api_parser.js to also work on li nodes. Page.exposeFunction.callback wording is normalized to match BrowserContext.exposeFunction.callback (equivalent meaning, slightly different wording).
pavelfeldman
force-pushed
the
docs-extract-alias-mixins
branch
from
82749d2 to
1d73527
Compare
Contributor
Test results for "MCP"1 failed 6942 passed, 1052 skipped Merge workflow run. |
Contributor
Test results for "tests 1"1 failed 1 flaky41653 passed, 851 skipped Merge workflow run. |
yury-s
reviewed
May 6, 2026
| ## drop-payload | ||
| - `payload` <[Object]> | ||
| - alias: DropPayload | ||
| - `files` ?<[path]|[Array]<[path]>|[Object]|[Array]<[Object]>> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
params.mdmixins:return-headers-array— used byAPIResponse.headersArray,Request.headersArray,Response.headersArray(csharp:Header, java:HttpHeader)expose-binding-callback— used byBrowserContext.exposeBinding,Page.exposeBinding(java:BindingCallback)expose-function-callback— used byBrowserContext.exposeFunction,Page.exposeFunction(java:FunctionCallback)Page.exposeFunction.callbackwording is normalized to matchBrowserContext.exposeFunction.callback(equivalent meaning, slightly different wording).