Skip to content

Commit

Permalink
fixed formatting issues after Zoomin upgrade to new doc portal (#124)
Browse files Browse the repository at this point in the history
  • Loading branch information
sallylanda6 committed Nov 23, 2022
1 parent 21e3d66 commit 3961249
Show file tree
Hide file tree
Showing 19 changed files with 73 additions and 31 deletions.
3 changes: 2 additions & 1 deletion content/en/docs/developer_guide/console/models.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
12 changes: 9 additions & 3 deletions content/en/docs/developer_guide/models/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/getting_started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/guide_openapi/openapi_tips.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading

0 comments on commit 3961249

Please sign in to comment.