Releases: advanced-rest-client/api-method-documentation
Releases · advanced-rest-client/api-method-documentation
Release list
v5.2.34
v5.2.33
@W-23748890 feat(query): add QUERY method color badge (OAS 3.2) (#100) * feat(query): add QUERY method color badge (OAS 3.2) OAS 3.2 introduces the QUERY HTTP method, which the archived http-method-label package does not map, so QUERY operations rendered in the default gray, indistinguishable from unmapped verbs. Add a local color override for the QUERY method label. ApiUrl upper-cases the method for display and lower-cases it for the color hook, so the badge shows QUERY while data-method is 'query'; the rule keys on both casings. Teal (#0f9d9d) is read-safe and does not collide with the PATCH purple. W-23748890 * feat(oas32): add COPY and MOVE method-label colors OAS 3.2 introduces the COPY and MOVE HTTP methods alongside QUERY. The http-method-label palette has no entry for them, so they fall back to the default gray. Add customizable color hooks matching the QUERY approach: COPY renders indigo, MOVE renders amber. Both are exposed as CSS custom properties (--http-method-label-copy/move-color and -background-color) with sensible fallbacks, and both raw (uppercase) and lower-cased data-method casings are keyed so navigation and documentation views agree. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * @W-23748890 test(query): drive QUERY label from generated OAS 3.2 model, bump generator to 0.4.0 Bump @api-components/api-model-generator ^0.2.14 -> ^0.4.0 (amf-client-js 5.11 supports OAS 3.1/3.2) and the amf-helper-mixin floor ^4.5.31 -> ^4.5.38. The regenerated 5.11 models wrap custom domain extensions (the x-agent extension on agents-api) in a single-element array; the agent resolver only navigates that shape from 4.5.38+, where _computeNodeAgent uses _findCustomDomainPropertyByKey instead of scanning for an inline amf://id# key. Add a real OAS 3.2 demo spec exercising the QUERY method and register it so prepare generates its model. Make test/amf-loader.js @graph-aware (amf-client-js 5.11 emits flattened @graph models; expand once at load time) and drive the QUERY method-label test from the generated model instead of hand-building AMF. COPY/MOVE stay inline with a comment: AMF 5.11 does not parse copy/move from an OAS 3.2 pathItem. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * @W-23748890 demo(query): surface oas32-query in the demo selector The QUERY method label (OAS 3.2) was registered in apis.json but not reachable from the demo: the hardcoded selector list omitted the spec, so the generated model never appeared in the dropdown. Add it as 'OAS 3.2 (QUERY)' so the QUERY badge can be previewed. * @W-23748890 chore(release): bump version to 5.2.33 * @W-23748890 chore(deps): update package-lock.json for api-navigation 4.3.24 and amf-helper-mixin 4.5.38 --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
v5.2.32
@W-23748894 feat(webhooks): show event name instead of URL for OAS 3.…
v5.2.31
fix(ApiUrl): show correct PUBLISH/SUBSCRIBE labels for AsyncAPI opera…
v5.2.30
@W-20359317 feat: Add gRPC support (#97) * feat: Add gRPC support to API documentation - Introduced methods to identify and handle gRPC operations within the API documentation. - Updated the display logic to differentiate between gRPC and standard methods, including appropriate titles and color styling. - Enhanced the APIUrl and ApiMethodDocumentation classes with new methods for gRPC stream types and display names. - Modified styles for better presentation of gRPC-related information. - Removed the temporary 'grpc-test' entry from the demo API list. * fix: Update title class handling in API method documentation - Modified the title class assignment in the API method documentation to dynamically set the class based on whether the method is a gRPC operation or not. This enhances the visual distinction between gRPC and standard methods in the documentation. * feat: Add gRPC test cases and update .gitignore - Introduced a new test file for gRPC API rendering, including various test cases to validate the correct handling of gRPC operations in the API documentation. - Added a new JSON file for gRPC testing to the demo directory and updated .gitignore to include this new file while excluding others. * feat: Implement endpoint and operation lookup methods in AmfLoader - Added `lookupEndpointByName` and `lookupOperationInEndpoint` methods to the AmfLoader for improved handling of gRPC operations. - Updated gRPC tests to utilize the new methods, enhancing code clarity and reducing redundancy in the test suite. * chore: Update package-lock.json with new dependencies and version upgrades - Added @advanced-rest-client/icons version 4.0.2 with its dependencies. - Upgraded @api-components/amf-helper-mixin from version 4.5.31 to 4.5.34. - Upgraded @api-components/api-navigation from version 4.3.3 to 4.3.20. - Updated dependencies for @anypoint-web-components/anypoint-button and others for better compatibility. * chore: Update dependencies and GitHub Actions workflow - Bump lockfile version from 2 to 3 in package-lock.json. - Upgrade @api-components/api-body-document from version 4.4.6 to 4.4.15. - Upgrade @commitlint/cli from version 13.2.0 to 13.2.1. - Update various @open-wc and @web dependencies for improved compatibility. - Refactor GitHub Actions workflow to use updated actions and improve caching strategy. - Change Node.js version to 18 in the workflow for better support. * chore: Update @api-components/api-responses-document and related dependencies - Bump @api-components/api-responses-document from version 4.2.5 to 4.2.6 in package.json and package-lock.json. - Upgrade @api-components/amf-helper-mixin from version 4.5.1 to 4.5.34. - Upgrade @api-components/api-annotation-document from version 4.1.0 to 4.2.1. - Upgrade @api-components/api-body-document from version 4.2.1 to 4.4.15. - Remove unused import of din-pro from demo/index.js. * refactor: Simplify gRPC tests to focus on regular model - Removed tests for the compact model as it is not generated by CI for gRPC. - Updated the test suite to only include the regular model, enhancing clarity and maintainability. * 5.2.30 * test: Normalize line endings in XML payload assertion for cross-platform compatibility - Updated the test for XML value computation to normalize line endings, ensuring consistent behavior across different operating systems. - Introduced a variable for the expected XML output to enhance readability and maintainability of the test case.
v5.2.29
W-19307418 Fix wording (#95) * refactor: Rename agent parameters computation method for clarity - Updated the method name from _computeAgentParameters to _computeAgentParametersByMethod for better readability. - Adjusted the parameter object to use isUserInput instead of isInputEnabled for improved clarity in the context of user input handling. * 5.2.29 * chore: Reorder Playwright browser installation in GitHub Actions workflow - Moved the installation of Playwright browsers to occur after dependency installation for improved workflow clarity and execution order. * test: Rename test assertion for user input clarity - Updated the test case from 'isInputEnabled' to 'isUserInput' to better reflect the parameter's purpose. - Adjusted the assertion to check for 'isUserInput' instead of 'isInputEnabled' for improved clarity in the context of user input handling.
v5.2.28
v5.2.27
Merge pull request #92 from advanced-rest-client/feat/release-5.2.27 Feat/release 5.2.27
v5.2.26
Merge pull request #91 from advanced-rest-client/feat/W-16600179/fix-…
v5.2.25
Merge pull request #90 from advanced-rest-client/feat/W-15594516/asyn…