From 396124901948eb4f5758513f415072d8ba3ddc6a Mon Sep 17 00:00:00 2001 From: sallylanda6 Date: Wed, 23 Nov 2022 09:23:15 -0700 Subject: [PATCH] fixed formatting issues after Zoomin upgrade to new doc portal (#124) --- .../en/docs/developer_guide/console/models.md | 3 +- .../manage_flows/flow_examples/count_users.md | 4 +- .../flow_examples/create_a_user.md | 2 + .../flow_examples/delete_a_user.md | 4 +- .../flow_examples/delete_all_users.md | 4 +- .../flow_examples/find_a_distinct_user.md | 4 +- .../flow_examples/find_a_user_by_id.md | 4 +- .../flow_examples/find_all_users.md | 4 +- .../flow_examples/find_and_modify_users.md | 4 +- .../flow_examples/query_a_user.md | 4 +- .../flow_examples/update_a_user.md | 4 +- .../flow_examples/upsert_a_user.md | 4 +- .../en/docs/developer_guide/models/create.md | 12 ++++-- content/en/docs/getting_started/_index.md | 2 +- content/en/docs/guide_openapi/openapi_tips.md | 2 +- ...microsoft_onedrive_using_rest_flow_node.md | 2 + .../docs/how_to/create_a_custom_flow_node.md | 37 ++++++++++++------- .../en/docs/nodejs_support_policy/_index.md | 2 +- content/en/docs/performance_metrics/_index.md | 2 +- 19 files changed, 73 insertions(+), 31 deletions(-) diff --git a/content/en/docs/developer_guide/console/models.md b/content/en/docs/developer_guide/console/models.md index e6459a33..869d81b0 100644 --- a/content/en/docs/developer_guide/console/models.md +++ b/content/en/docs/developer_guide/console/models.md @@ -21,12 +21,13 @@ To create a new model using the UI: 1. Click the **\+ Model** button. 1. In the model window. -![new_model_%281%29_latest](/Images/55477331_new_model_(1)_latest.png) + ![new_model_%281%29_latest](/Images/55477331_new_model_(1)_latest.png) 1. Enter the **Model name** (required). 1. Select a **Connector** (required). 1. Enter a **Description** for the new model. While this is an optional field, we encourage you to provide a clear and concise description of what the model does. 1. Click **Next** to start the process of creating a new model. + 1. In the New Model page, you will see the name of the model you just created with an option to edit that name and the Connector you selected for it to use. 1. To add a new field, click the **\+ Field** button. In the model window, diff --git a/content/en/docs/developer_guide/flows/manage_flows/flow_examples/count_users.md b/content/en/docs/developer_guide/flows/manage_flows/flow_examples/count_users.md index 16931d18..87c95a6c 100644 --- a/content/en/docs/developer_guide/flows/manage_flows/flow_examples/count_users.md +++ b/content/en/docs/developer_guide/flows/manage_flows/flow_examples/count_users.md @@ -23,7 +23,9 @@ The API Orchestration user interface is displayed. 1. Enable the **body** parameter, select **selector**, and enter `$.count` in the field. 1. Leave the **headers** parameter disabled. 1. Connect the next output of the Count users flow-node to the input of the Count succeeded flow-node. For additional information on connecting flow-nodes in a flow, refer to [Manage flow-nodes](/docs/developer_guide/flows/manage_flow_nodes/). The completed flow is displayed. -![Count_01_latest](/Images/count_01_latest.png) + + ![Count_01_latest](/Images/count_01_latest.png) + 1. Click **Apply**. 1. On the next screen, click **Proceed**. The server will be restarted, the _Count users_ flow will be saved and enabled, and you will be returned to the API Orchestration user interface. 1. To exit API Orchestration user interface and return to API Lists page, click **Close**. diff --git a/content/en/docs/developer_guide/flows/manage_flows/flow_examples/create_a_user.md b/content/en/docs/developer_guide/flows/manage_flows/flow_examples/create_a_user.md index 5a7a5c72..f583a275 100644 --- a/content/en/docs/developer_guide/flows/manage_flows/flow_examples/create_a_user.md +++ b/content/en/docs/developer_guide/flows/manage_flows/flow_examples/create_a_user.md @@ -38,7 +38,9 @@ To configure a create a user flow: 1. Leave the **body** and **headers** parameters disabled. 1. Connect the next output of the Set header location flow-node to the input of the Create succeeded flow-node. For additional information on connecting flow-nodes in a flow, refer to [Manage flow-nodes](/docs/developer_guide/flows/manage_flow_nodes/). 1. Connect the error output of the Set header location flow-node to the input of the Create failed flow-node. For additional information on connecting flow-nodes in a flow, refer to [Manage flow-nodes](/docs/developer_guide/flows/manage_flow_nodes/). The completed flow is displayed. + ![image2019-8-6_15_55_45](/Images/image2019_8_6_15_55_45.png) + 1. Click **Apply**. 1. On the next screen, click **Proceed**. The server will be restarted, the _Create a user_ flow will be saved and enabled, and you will be returned to the API Orchestration user interface. 1. To exit API Orchestration user interface and return to API Lists page, click **Close**. diff --git a/content/en/docs/developer_guide/flows/manage_flows/flow_examples/delete_a_user.md b/content/en/docs/developer_guide/flows/manage_flows/flow_examples/delete_a_user.md index 2da46196..796f0c96 100644 --- a/content/en/docs/developer_guide/flows/manage_flows/flow_examples/delete_a_user.md +++ b/content/en/docs/developer_guide/flows/manage_flows/flow_examples/delete_a_user.md @@ -29,7 +29,9 @@ To configure a delete a user flow: 1. Leave the **body** and **headers** parameters disabled. 1. Connect the next output of the Delete a user flow-node to the input of the Delete succeeded flow-node. For additional information on connecting flow-nodes in a flow, refer to [Manage flow-nodes](/docs/developer_guide/flows/manage_flow_nodes/). 1. Connect the notfound output of the Delete a user flow-node to the input of the User not found flow-node. For additional information on connecting flow-nodes in a flow, refer to [Manage flow-nodes](/docs/developer_guide/flows/manage_flow_nodes/). The completed flow is displayed. -![Delete_01_latest](/Images/delete_01_latest.png) + + ![Delete_01_latest](/Images/delete_01_latest.png) + 1. Click **Apply**. 1. On the next screen, click **Proceed**. The server will be restarted, the _Delete a user_ flow will be saved and enabled, and you will be returned to the API Orchestration user interface. 1. To exit API Orchestration user interface and return to API Lists page, click **Close**. diff --git a/content/en/docs/developer_guide/flows/manage_flows/flow_examples/delete_all_users.md b/content/en/docs/developer_guide/flows/manage_flows/flow_examples/delete_all_users.md index c162369a..8e5defb6 100644 --- a/content/en/docs/developer_guide/flows/manage_flows/flow_examples/delete_all_users.md +++ b/content/en/docs/developer_guide/flows/manage_flows/flow_examples/delete_all_users.md @@ -20,7 +20,9 @@ To configure a delete all users flow: 1. For the **status** parameter, select **number** and enter `204` in the field. 1. Leave the **body** and **headers** parameters disabled. 1. Connect the next output of the Delete all users flow-node to the input of the Delete succeeded flow-node. For additional information on connecting flow-nodes in a flow, refer to [Manage flow-nodes](/docs/developer_guide/flows/manage_flow_nodes/). The completed flow is displayed. -![Delete_all_latest](/Images/delete_all_latest.png) + + ![Delete_all_latest](/Images/delete_all_latest.png) + 1. Click **Apply**. 1. On the next screen, click **Proceed**. The server will be restarted, the _Delete all users_ flow will be saved and enabled, and you will be returned to the API Orchestration user interface. 1. To exit API Orchestration user interface and return to API Lists page, click **Close**. diff --git a/content/en/docs/developer_guide/flows/manage_flows/flow_examples/find_a_distinct_user.md b/content/en/docs/developer_guide/flows/manage_flows/flow_examples/find_a_distinct_user.md index 0efacfbf..9f55f4c5 100644 --- a/content/en/docs/developer_guide/flows/manage_flows/flow_examples/find_a_distinct_user.md +++ b/content/en/docs/developer_guide/flows/manage_flows/flow_examples/find_a_distinct_user.md @@ -23,7 +23,9 @@ To configure a find a distinct user flow: 1. Enable the **body** parameter, select **selector**, and select `$.models` from the selector options drop-down menu or continue typing to complete the selector configuration manually. For additional selector auto-complete information, refer to [Manage flow-nodes](/docs/developer_guide/flows/manage_flow_nodes/). 1. Leave the **headers** parameter disabled. 1. Connect the next output of the Find a distinct user flow-node to the input of the Find succeeded flow-node. For additional information on connecting flow-nodes in a flow, refer to [Manage flow-nodes](/docs/developer_guide/flows/manage_flow_nodes/). The completed flow is displayed. -![Distinct_latest](/Images/distinct_latest.png) + + ![Distinct_latest](/Images/distinct_latest.png) + 1. Click **Apply**. 1. On the next screen, click **Proceed**. The server will be restarted, the _Find a distinct user_ flow will be saved and enabled, and you will be returned to the API Orchestration user interface. 1. To exit API Orchestration user interface and return to API Lists page, click **Close**. diff --git a/content/en/docs/developer_guide/flows/manage_flows/flow_examples/find_a_user_by_id.md b/content/en/docs/developer_guide/flows/manage_flows/flow_examples/find_a_user_by_id.md index 574e6197..9bdfe96d 100644 --- a/content/en/docs/developer_guide/flows/manage_flows/flow_examples/find_a_user_by_id.md +++ b/content/en/docs/developer_guide/flows/manage_flows/flow_examples/find_a_user_by_id.md @@ -30,7 +30,9 @@ To configure a find a user by ID flow: 1. For the **status** parameter, select **number** and enter `404` in the field. 1. Leave the **body** and **headers** parameters disabled. 1. Connect the notfound output of the Find a user by ID flow-node to the input of the User not found flow-node. For additional information on connecting flow-nodes in a flow, refer to [Manage flow-nodes](/docs/developer_guide/flows/manage_flow_nodes/). The completed flow is displayed. -![Find_by_ID_latest](/Images/find_by_id_latest.png) + + ![Find_by_ID_latest](/Images/find_by_id_latest.png) + 1. Click **Apply**. 1. On the next screen, click **Proceed**. The server will be restarted, the _Find a user by ID_ flow will be saved and enabled, and you will be returned to the API Orchestration user interface. 1. To exit API Orchestration user interface and return to API Lists page, click **Close**. diff --git a/content/en/docs/developer_guide/flows/manage_flows/flow_examples/find_all_users.md b/content/en/docs/developer_guide/flows/manage_flows/flow_examples/find_all_users.md index 863e858e..5827b7cd 100644 --- a/content/en/docs/developer_guide/flows/manage_flows/flow_examples/find_all_users.md +++ b/content/en/docs/developer_guide/flows/manage_flows/flow_examples/find_all_users.md @@ -21,7 +21,9 @@ To configure a find all users flow: 1. Enable the **body** parameter, select **selector**, and select `$.models` from the selector options drop-down menu or continue typing to manually complete the selector configuration. For additional selector auto-complete information, refer to [Manage flow-nodes](/docs/developer_guide/flows/manage_flow_nodes/). 1. Leave the **headers** parameter disabled. 1. Connect the next output of the Find all users flow-node to the input of the Find succeeded flow-node. For additional information on connecting flow-nodes in a flow, refer to [Manage flow-nodes](/docs/developer_guide/flows/manage_flow_nodes/). The completed flow is displayed. -![Find_all_latest](/Images/find_all_latest.png) + + ![Find_all_latest](/Images/find_all_latest.png) + 1. Click **Apply**. 1. On the next screen, click **Proceed**. The server will be restarted, the _Find all users_ flow will be saved and enabled, and you will be returned to the API Orchestration user interface. 1. To exit API Orchestration user interface and return to API Lists page, click **Close**. diff --git a/content/en/docs/developer_guide/flows/manage_flows/flow_examples/find_and_modify_users.md b/content/en/docs/developer_guide/flows/manage_flows/flow_examples/find_and_modify_users.md index 3ad9eb91..3c62cd39 100644 --- a/content/en/docs/developer_guide/flows/manage_flows/flow_examples/find_and_modify_users.md +++ b/content/en/docs/developer_guide/flows/manage_flows/flow_examples/find_and_modify_users.md @@ -44,7 +44,9 @@ To configure a find and modify users flow: 1. For the **status** parameter, select **number** and enter `404` in the field. 1. Leave the **body** and **headers** parameters disabled. 1. Connect the notfound output of the Find and modify users flow-node to the input of the Users not found flow-node. For additional information on connecting flow-nodes in a flow, refer to [Manage flow-nodes](/docs/developer_guide/flows/manage_flow_nodes/). The completed flow is displayed. -![Find_and_modify_latest](/Images/find_and_modify_latest.png) + + ![Find_and_modify_latest](/Images/find_and_modify_latest.png) + 1. Click **Apply**. 1. On the next screen, click **Proceed**. The server will be restarted, the _Find and modify users_ flow will be saved and enabled, and you will be returned to the API Orchestration user interface. 1. To exit API Orchestration user interface and return to API Lists page, click **Close**. diff --git a/content/en/docs/developer_guide/flows/manage_flows/flow_examples/query_a_user.md b/content/en/docs/developer_guide/flows/manage_flows/flow_examples/query_a_user.md index e32a8a95..23a550ab 100644 --- a/content/en/docs/developer_guide/flows/manage_flows/flow_examples/query_a_user.md +++ b/content/en/docs/developer_guide/flows/manage_flows/flow_examples/query_a_user.md @@ -23,7 +23,9 @@ To configure a query a user flow: 1. Enable the **body** parameter, select **selector**, and select `$.models` from the selector options drop-down menu or continue typing to manually complete the selector configuration. For additional selector auto-complete information, refer to [Manage flow-nodes](/docs/developer_guide/flows/manage_flow_nodes/). 1. Leave the **headers** parameter disabled. 1. Connect the next output of the Query a user flow-node to the input of the Query succeeded flow-node. For additional information on connecting flow-nodes in a flow, refer to [Manage flow-nodes](/docs/developer_guide/flows/manage_flow_nodes/). The completed flow is displayed. -![Query_latest](/Images/query_latest.png) + + ![Query_latest](/Images/query_latest.png) + 1. Click **Apply**. 1. On the next screen, click **Proceed**. The server will be restarted, the _Query a user_ flow will be saved and enabled, and you will be returned to the API Orchestration user interface. 1. To exit API Orchestration user interface and return to API Lists page, click **Close**. diff --git a/content/en/docs/developer_guide/flows/manage_flows/flow_examples/update_a_user.md b/content/en/docs/developer_guide/flows/manage_flows/flow_examples/update_a_user.md index 013a0ce9..3a20b33b 100644 --- a/content/en/docs/developer_guide/flows/manage_flows/flow_examples/update_a_user.md +++ b/content/en/docs/developer_guide/flows/manage_flows/flow_examples/update_a_user.md @@ -29,7 +29,9 @@ To configure an update a user flow: 1. For the **status** parameter, select **number** and enter `404` in the field. 1. Leave the **body** and **headers** parameters disabled. 1. Connect the notfound output of the Update a user flow-node to the input of the User not found flow-node. For additional information on connecting flow-nodes in a flow, refer to [Manage flow-nodes](/docs/developer_guide/flows/manage_flow_nodes/). The completed flow is displayed. -![Update_latest](/Images/update_latest.png) + + ![Update_latest](/Images/update_latest.png) + 1. Click **Apply**. 1. On the next screen, click **Proceed**. The server will be restarted, the _Update a user_ flow will be saved and enabled, and you will be returned to the API Orchestration user interface. 1. To exit API Orchestration user interface and return to API Lists page, click **Close**. diff --git a/content/en/docs/developer_guide/flows/manage_flows/flow_examples/upsert_a_user.md b/content/en/docs/developer_guide/flows/manage_flows/flow_examples/upsert_a_user.md index f5a48ccf..c747f227 100644 --- a/content/en/docs/developer_guide/flows/manage_flows/flow_examples/upsert_a_user.md +++ b/content/en/docs/developer_guide/flows/manage_flows/flow_examples/upsert_a_user.md @@ -36,7 +36,9 @@ To configure an upsert (update or insert) a user flow: 1. Enable the **headers** parameter, select **selector**, and select `$.headers` from the selector options drop-down menu or continue typing to complete the selector configuration manually. For additional selector auto-complete information, refer to [Manage flow-nodes](/docs/developer_guide/flows/manage_flow_nodes/). 1. Connect the insert output of the Upsert a user flow-node to the input of the Insert succeeded flow-node. For additional information on connecting flow-nodes in a flow, refer to [Manage flow-nodes](/docs/developer_guide/flows/manage_flow_nodes/). 1. Connect the next output of the Set location flow-node to the input of the Insert succeeded flow-node. For additional information on connecting flow-nodes in a flow, refer to [Manage flow-nodes](/docs/developer_guide/flows/manage_flow_nodes/). The completed flow is displayed. -![Upsert_latest](/Images/upsert_latest.png) + + ![Upsert_latest](/Images/upsert_latest.png) + 1. Click **Apply**. 1. On the next screen, click **Proceed**. The server will be restarted, the _Upsert a user_ flow will be saved and enabled, and you will be returned to the API Orchestration user interface. 1. To exit API Orchestration user interface and return to API Lists page, click **Close**. diff --git a/content/en/docs/developer_guide/models/create.md b/content/en/docs/developer_guide/models/create.md index f42483b9..05698bf2 100644 --- a/content/en/docs/developer_guide/models/create.md +++ b/content/en/docs/developer_guide/models/create.md @@ -12,13 +12,17 @@ Let's create a new model. In the Admin Console: 1. Click the **Models** tab. 1. Click the **\+ Model** button on the right side. 1. In the New Model step: -![new_model_%281%29_latest](/Images/55476489_new_model_(1)_latest.png) + + ![new_model_%281%29_latest](/Images/55476489_new_model_(1)_latest.png) + 1. Enter "simpleuser" in the **Model name** field (required). The name must be unique for all of the application's models. 1. Select a **Connector** from the drop-down list (required). Connectors are used to persist data to the model. 1. Add a description. 1. Click **Next** to move onto the fields step. 1. In the Create Model Fields step: -![add_fields](/Images/add_fields.png) + + ![add_fields](/Images/add_fields.png) + 1. Click the **\+ Field** button. 1. Enter "first_name" in the Field name field (required). ![create_fields](/Images/create_fields.png) @@ -30,7 +34,9 @@ Let's create a new model. In the Admin Console: 1. Repeat step 4 as necessary to add the "last_name" and "email" fields to this model. After you add the fields, you can configure them by changing properties or adding validation or return logic. 1. Click **Next** to move onto the endpoint step. 1. In the API endpoint page: -![add_endpoints](/Images/add_endpoints.png) + + ![add_endpoints](/Images/add_endpoints.png) + 1. Make sure the **Create**, **Retrieve**, **Update**, and **Delete** methods are checked. 1. Click Save to commit your new model to the app. diff --git a/content/en/docs/getting_started/_index.md b/content/en/docs/getting_started/_index.md index d130507d..077d24d1 100644 --- a/content/en/docs/getting_started/_index.md +++ b/content/en/docs/getting_started/_index.md @@ -15,7 +15,7 @@ The latest version of {{% variables/apibuilder_prod_name %}} maintains compatibi These are the absolute minimum requirements for running an {{% variables/apibuilder_prod_name %}} service. Memory and disk usage may fluctuate over time and between releases. Recommended system specs should be significantly higher to account for additional plugins, inbound requests and custom service logic. -| | Development | Production | +| Type | Development | Production | | --- | --- | --- | | HDD | 110MB | 80MB | | RAM | 45MB | 40MB | diff --git a/content/en/docs/guide_openapi/openapi_tips.md b/content/en/docs/guide_openapi/openapi_tips.md index ec393fcd..3bd2b93c 100644 --- a/content/en/docs/guide_openapi/openapi_tips.md +++ b/content/en/docs/guide_openapi/openapi_tips.md @@ -21,7 +21,7 @@ Typically, entities would have a plural root, e.g. `/users`, under which all met | PUT | `/users/{id}` | 204 No Content | | Update user by ID | | DELETE | `/users/{id}` | 204 No Content | | Delete user by | -1. `POST` operations to create a resource would typically return a `Location` header that is the URL for the newly created resource, but no response body. +`POST` operations to create a resource would typically return a `Location` header that is the URL for the newly created resource, but no response body. In OpenAPI, resource values are described by [JSON schema](https://json-schema.org/). You may want to read our [JSON schema tips](#json-schema-tips) before designing resources and writing your OpenAPI specification. diff --git a/content/en/docs/how_to/authorization_access_microsoft_onedrive_using_rest_flow_node.md b/content/en/docs/how_to/authorization_access_microsoft_onedrive_using_rest_flow_node.md index 43c669d9..e371c295 100644 --- a/content/en/docs/how_to/authorization_access_microsoft_onedrive_using_rest_flow_node.md +++ b/content/en/docs/how_to/authorization_access_microsoft_onedrive_using_rest_flow_node.md @@ -295,7 +295,9 @@ We will go through the steps to create the flow, but for reference, the complete ] ``` 1. On the **Outputs** tab, change the **Next** output to `$.contents`. + ![responsedot_params](/Images/responsedot_params.png) ![responsedot_outputs](/Images/responsedot_outputs.png) + 1. Drag an HTTP flow-node from the tool panel; this only has a single `Set HTTP Response` method. We will use this node to configure the response that is returned to the caller. 1. Connect the **Next** output of the Format Response node to the new Set HTTP Response node. diff --git a/content/en/docs/how_to/create_a_custom_flow_node.md b/content/en/docs/how_to/create_a_custom_flow_node.md index 654b40e1..d79b4a5d 100644 --- a/content/en/docs/how_to/create_a_custom_flow_node.md +++ b/content/en/docs/how_to/create_a_custom_flow_node.md @@ -110,10 +110,12 @@ flow-nodes: To explain what occurs in the `src/flow-nodes.yaml` file, we will break the file down piece by piece. -1. The file defines a structure, a specification, that determines: - * The flow-node(s) to export. - * The method(s) that comprise each flow-node. -1. The first portion of it allows you to define the flow-node name, icon, description, and category: +The file defines a structure, a specification, that determines: +* The flow-node(s) to export. +* The method(s) that comprise each flow-node. + +The first portion of it allows you to define the flow-node name, icon, description, and category: + ```yaml encodeuri: name: Encode URI @@ -122,12 +124,14 @@ To explain what occurs in the `src/flow-nodes.yaml` file, we will break the file category: utils ... ``` - The `name` is the text that is displayed in the Flow Editor. - The default `icon` is a placeholder (a star) that should be replaced with a graphic that represents the action of the flow-node. The icon is displayed at 28 pixels by 28 pixels. - The `description` is the text that is displayed in the Flow Editor to describe your flow-node. - The `category` is the section in the Flow Editor tool panel where the flow-node is contained. -1. The next section adds a single method `encode` and describe its parameters and outputs: +* The `name` is the text that is displayed in the Flow Editor. +* The default `icon` is a placeholder (a star) that should be replaced with a graphic that represents the action of the flow-node. The icon is displayed at 28 pixels by 28 pixels. +* The `description` is the text that is displayed in the Flow Editor to describe your flow-node. +* The `category` is the section in the Flow Editor tool panel where the flow-node is contained. + +The next section adds a single method `encode` and describe its parameters and outputs: + ```yaml methods: encode: # This same key is used in `actions.js` @@ -143,9 +147,13 @@ To explain what occurs in the `src/flow-nodes.yaml` file, we will break the file type: string ... ``` - A method called `encode`, that is displayed in the Flow Editor as **Encode URI**, was added. The `encode` method has a single parameter. If we needed more parameters, we would repeat the whole `parameter`block. ![Screen_Shot_2020-05-19_at_3.12.19_PM](/Images/screen_shot_2020_05_19_at_3_12_19_pm.png) -1. The next two sections after the parameters defines the value that is returned from your action method and the Error that may be thrown from your action method: +A method called `encode`, that is displayed in the Flow Editor as **Encode URI**, was added. The `encode` method has a single parameter. If we needed more parameters, we would repeat the whole `parameter`block. + +![Screen_Shot_2020-05-19_at_3.12.19_PM](/Images/screen_shot_2020_05_19_at_3_12_19_pm.png) + +The next two sections after the parameters defines the value that is returned from your action method and the Error that may be thrown from your action method: + ```yaml parameters: ... @@ -164,7 +172,8 @@ To explain what occurs in the `src/flow-nodes.yaml` file, we will break the file schema: type: string ``` -1. Understand how actions work - The method key correlates to an action in the **src/actions.js** file. We renamed the example method from \`hello\` to \`_encode_\` above in the flow-node specification in flow-nodes.yml, now we need to also rename it in src/actions.js in Step 4. + +Understand how actions work - The method key correlates to an action in the **src/actions.js** file. We renamed the example method from \`hello\` to \`_encode_\` above in the flow-node specification in flow-nodes.yml, now we need to also rename it in src/actions.js in Step 4. ### Step 4: Customize the flow-node method implementation @@ -230,7 +239,7 @@ All we need to do now is clean up the Greet Flow from the sample greet flow-node Notice the flow-node is still red, this is because we defined our \`uri\` parameter as required. Another thing worth noting is that we did set \`initialType: string\` in our specification, so we see it being selected by default in the UI. -We could dynamically get the URI from a selector, but to keep things simple lets set the uri we want to encode as String - i.e. \`http://example.com/?q=my query\`. +We could dynamically get the URI from a selector, but to keep things simple lets set the uri we want to encode as String - i.e. `http://example.com/?q=my query\`. ![Screen_Shot_2020-05-19_at_3.10.11_PM](/Images/screen_shot_2020_05_19_at_3_10_11_pm.png) @@ -241,7 +250,9 @@ Next and final step is to define in which context variable the response will be Now that we know what our flow-nodes is going to set, we can select the \`Success (HTTP 200)\` flow-node and amend it to include the result of our flow-node in it is body: ![Screen_Shot_2020-05-18_at_6.29.30_PM](/Images/screen_shot_2020_05_18_at_6_29_30_pm.png) + With that done, all we need to do is run and see our flow-node in action! To do so you can click on the debugger icon and expand it. + ![Screen_Shot_2020-05-18_at_6.35.39_PM](/Images/screen_shot_2020_05_18_at_6_35_39_pm.png) As we tweaked the Greet flow, we still have the username as required in that flow, so just pass any value as \`username\` to it and click \`Execute Flow\`. diff --git a/content/en/docs/nodejs_support_policy/_index.md b/content/en/docs/nodejs_support_policy/_index.md index 56331021..07c1679a 100644 --- a/content/en/docs/nodejs_support_policy/_index.md +++ b/content/en/docs/nodejs_support_policy/_index.md @@ -5,7 +5,7 @@ weight: 130 date: 2021-10-01 --- -| | | +| Requirement | Version | | --- | --- | | Recommended | {{% variables/recommended_node %}} or greater | | Minimum | {{% variables/minimum_node %}} | diff --git a/content/en/docs/performance_metrics/_index.md b/content/en/docs/performance_metrics/_index.md index 72d98c20..c0743b53 100644 --- a/content/en/docs/performance_metrics/_index.md +++ b/content/en/docs/performance_metrics/_index.md @@ -21,7 +21,7 @@ The performance of a flow depends significantly on what the flow is doing. Conne ## Performance metrics -| | | +| Type | Metrics | | --- | --- | | Date of test | March 2022 ([Johannesburg](/docs/release_notes/johannesburg)) | | Number of requests | 100,000 |