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.

Author: alexpmule

.github/workflows/deployment.yml

@@ -27,10 +27,10 @@ jobs:
         with:
           node-version: 18
           cache: 'npm'
-      - name: Install Playwright Browsers
-        run: npx playwright install --with-deps
       - name: Install dependencies
         run: npm ci
+      - name: Install Playwright Browsers
+        run: npx playwright install --with-deps
       - name: Run tests
         run: npm test
   # test_win:

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@api-components/api-method-documentation",
   "description": "A HTTP method documentation build from AMF model",
-  "version": "5.2.28",
+  "version": "5.2.29",
   "license": "Apache-2.0",
   "main": "index.js",
   "module": "index.js",

package.json

@@ -473,7 +473,7 @@ export class ApiMethodDocumentation extends AmfHelperMixin(LitElement) {
     this.operationId = this._getValue(method, this.ns.aml.vocabularies.apiContract.operationId);
     this.callbacks = this._computeCallbacks(method);
     this.deprecated = this._computeIsDeprecated(method);
-    this.agentParameters = this._computeAgentParameters(method);
+    this.agentParameters = this._computeAgentParametersByMethod(method);
   }
 
   _computeAsyncApiSecurity(){
@@ -1387,7 +1387,7 @@ export class ApiMethodDocumentation extends AmfHelperMixin(LitElement) {
     return undefined;
   }
 
-  _computeAgentParameters(method) {
+  _computeAgentParametersByMethod(method) {
     if (!method) {
       return undefined;
     }
@@ -1421,10 +1421,10 @@ export class ApiMethodDocumentation extends AmfHelperMixin(LitElement) {
     if (!isUserInput) {
       return undefined;
     }
-    const isInputEnabled = this._getValue(isUserInput[0], this.ns.aml.vocabularies.data.value);
+    const isInputValue = this._getValue(isUserInput[0], this.ns.aml.vocabularies.data.value);
 
     const params = {
-      isInputEnabled,
+      isUserInput: isInputValue,
     };
 
     return params;

src/ApiMethodDocumentation.js

@@ -23,12 +23,12 @@ describe('agent-api', function() {
         amf = await AmfLoader.load(apiFile, compact);
       });
 
-      it('isInputEnabled is true', async () => {
+      it('isUserInput is true', async () => {
         const endpopint = AmfLoader.lookupEndpoint(amf, '/reservations/reservationlookup');
         const method = AmfLoader.lookupOperation(amf, '/reservations/reservationlookup', 'get');
         element = await modelFixture(amf, endpopint, method);
         await aTimeout();
-        assert.equal(element.agentParameters.isInputEnabled, 'true');
+        assert.equal(element.agentParameters.isUserInput, 'true');
       });
 
       it('renders the summary', async () => {