mirror of
https://github.com/noodlapp/noodl-docs.git
synced 2026-01-12 23:32:54 +01:00
Initial commit
Co-Authored-By: kotte <14197736+mrtamagotchi@users.noreply.github.com> Co-Authored-By: mikaeltellhed <2311083+mikaeltellhed@users.noreply.github.com> Co-Authored-By: Tore Knudsen <18231882+torekndsn@users.noreply.github.com> Co-Authored-By: Michael Cartner <32543275+michaelcartner@users.noreply.github.com>
This commit is contained in:
33
library/prefabs/xano/components/xano-request/README.md
Normal file
33
library/prefabs/xano/components/xano-request/README.md
Normal file
@@ -0,0 +1,33 @@
|
||||
---
|
||||
title: Request
|
||||
hide_title: true
|
||||
---
|
||||
|
||||
# Request
|
||||
|
||||
This component is used to call Xano API endpoints.
|
||||
|
||||
> Please note that [Xano Client](/library/prefabs/xano/components/setup-xanoclient/) needs to be set up in your app before you can properly use this component.
|
||||
|
||||
## Inputs
|
||||
|
||||
| Data | Description |
|
||||
| ---------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-data">Endpoint</span> | The path of the endpoint to be called within the API Group, like `/auth/signup` or `/auth/login`. |
|
||||
| <span className="ndl-data">Request Type</span> | The type of request you want send. Follows the HTTP standards `GET`, `POST`, `PUT`, `PATCH` and `DELETE`. |
|
||||
| <span className="ndl-data">Data</span> | A JSON formatted payload that will be sent as Request Body. |
|
||||
|
||||
| Signals | Description |
|
||||
| -------------------------------------- | -------------------------------------------------- |
|
||||
| <span className="ndl-signal">Do</span> | Sends a Signal to this input to start the request. |
|
||||
|
||||
## Outputs
|
||||
|
||||
| Data | Description |
|
||||
| ------------------------------------------ | --------------------------------------------- |
|
||||
| <span className="ndl-data">Response</span> | The JSON formatted response from the request. |
|
||||
|
||||
| Signals | Description |
|
||||
| ------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||
| <span className="ndl-signal">Success</span> | Sends a signal when the request succeeded. |
|
||||
| <span className="ndl-signal">Failure</span> | Sends a signal when an error occurred, and logs an error message in the console. |
|
||||
Reference in New Issue
Block a user