Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions _README_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
<!-- Name your function -->
# ⚡ Template Function

<!-- Write short function tagline -->
Function with missing description.
Comment thread
Meldiron marked this conversation as resolved.
Outdated

## 🧰 Usage

<!-- Copy section for each endpoint -->
<!-- Document endpoint method and url -->
### `GET /`

<!-- Describe the endpoint -->
Endpoint with missing description.
Comment thread
Meldiron marked this conversation as resolved.
Outdated

**Parameters**
<!-- Document each expected parameter -->
| Name | Description | Location | Type | Sample Value |
|--------|---------------------------------|------------------------------|------------------------------------|--------------|
| userId | Param with missing description. | Path / Query / Body / Header | String / Number / Boolean / Object | 642...7cd |

**Response**

<!-- Provide sample body for successful response -->

Sample `200` Response:

```json
{ "ok": true }
```

<!-- If relevant, document error responses -->

Sample `400` Response:

```json
{ "ok": false, "message": "Missing userId parameter." }
```

## ⚙️ Configuration

<!-- Update values and remove irelevant settings -->
Comment thread
Meldiron marked this conversation as resolved.
Outdated
| Setting | Value |
|----------------|----------------|
| Runtime | Node (18.0) |
| Entrypoint | src/main.js |
| Build Commands | npm run build |
| Permissions | any |
| Events | users.*.create |
| CRON | 0 * * * * |
| Timeout | 15 (Seconds) |

## 🔒 Environment Variables

<!-- Copy section for each variable -->
<!-- Name the variable -->
### APPWRITE_API_KEY

<!-- Describe the variable -->
API Key to talk to Appwrite backend APIs.

<!-- Mark if variable is required or not -->
<!-- Provide sample (but invalid) value -->
<!-- Link to docs or remove if irelevant -->
Comment thread
Meldiron marked this conversation as resolved.
Outdated
| Question | Answer |
|----------------|-----------------|
| Required | Yes / No |
| Sample Value | `d1efb...aec35` |
| Documentation | [Appwrite: Getting Started for Server](https://appwrite.io/docs/getting-started-for-server#apiKey) |