Skip to content

Commit 513c292

Browse files
committed
Address review comments
1 parent f8189ac commit 513c292

File tree

1 file changed

+56
-9
lines changed

1 file changed

+56
-9
lines changed

docs/resources/projects/settings/project-apis.md

Lines changed: 56 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ tags: [APIs, Projects]
55
keywords: [projects, apis, refactor code]
66
sidebar_position: 5
77
---
8+
import Tabs from '@theme/Tabs';
9+
import TabItem from '@theme/TabItem';
810

911
# Project API
1012

@@ -26,25 +28,70 @@ Before using the Project YAML API, make sure you have the following:
2628

2729
:::
2830

31+
## YAML Overview
32+
33+
### What are FlutterFlow Project YAMLs?
34+
35+
YAML (YAML Ain't Markup Language) is a human-readable data serialization format commonly used for configuration files. In FlutterFlow, **Project YAMLs represent the complete structural definition of your app,** essentially exposing the full project schema that powers your FlutterFlow app.
36+
37+
### What's Included in the Project Schema?
38+
39+
FlutterFlow's YAML files contain a comprehensive representation of your entire project, including:
40+
41+
- **UI Components & Pages**: Widget trees, page layouts, component hierarchies, and styling configurations.
42+
- **App Configuration**: Settings like app details, authentication methods, integrations (AdMob, Firebase, etc.)
43+
- **Data Structures**: Database collections, API schemas, app state variables, and custom data types.
44+
- **Business Logic**: Actions, functions, conditional logic, and workflow definitions.
45+
- **Assets & Resources**: Custom code files, image references, fonts, and other project assets.
46+
- **Project Organization**: Folder structures, component libraries, and project metadata.
47+
48+
### YAML vs. FlutterFlow UI
49+
50+
Every change you make in the FlutterFlow visual editor — from dragging a widget onto a page to configuring a database collection, is ultimately stored as structured data in these YAML files. The FlutterFlow UI provides an intuitive visual interface for editing this underlying schema, while the Project API gives you direct programmatic access to the same data.
51+
52+
### File Structure
53+
54+
FlutterFlow automatically partitions your project into logical YAML files for optimal performance and organization. Each file represents a specific aspect of your project (e.g., `app-state`, `ad-mob`, individual pages, collections, etc.), making it easy to target specific updates without affecting the entire project.
55+
2956
## Base URL
3057

3158
FlutterFlow provides different API endpoints for various environments. Use the appropriate base URL below depending on your needs:
3259

33-
#### Production:
60+
<Tabs>
61+
<TabItem value="1" label="Production" default>
3462
```jsx
3563
https://api.flutterflow.io/v2/
3664
```
37-
#### Beta/Staging:
65+
</TabItem>
66+
<TabItem value="2" label="Beta/Staging">
3867
```jsx
3968
https://api.flutterflow.io/v2-staging/
4069
```
70+
</TabItem>
71+
<TabItem value="3" label="Enterprise">
4172

42-
#### Enterprise:
43-
- India: `https://api-enterprise-india.flutterflow.io/v2/`
44-
- APAC: `https://api-enterprise-apac.flutterflow.io/v2/`
45-
- US Central: `https://api-enterprise-us-central.flutterflow.io/v2/`
46-
- Europe: `https://api-enterprise-europe.flutterflow.io/v2/`
73+
**India**
74+
```jsx
75+
https://api-enterprise-india.flutterflow.io/v2/
76+
```
77+
78+
**APAC**
79+
```jsx
80+
https://api-enterprise-apac.flutterflow.io/v2/
81+
```
4782

83+
**US Central**
84+
```jsx
85+
https://api-enterprise-us-central.flutterflow.io/v2/
86+
```
87+
88+
**Europe**
89+
```jsx
90+
https://api-enterprise-europe.flutterflow.io/v2/
91+
```
92+
</TabItem>
93+
</Tabs>
94+
4895
## Authentication
4996

5097
All API endpoints require authentication using a Bearer token. You'll need to include your FlutterFlow API token in the Authorization header of each request. See [how to get the API Token](../../../accounts-billing/account-management.md#how-do-i-generate-an-api-token).
@@ -165,7 +212,7 @@ You must validate the YAML content before applying changes to ensure it's proper
165212
:::info
166213

167214
- In the `fileContent` object, you must provide the **entire content** of the file.
168-
- The YAML content must be passed as a **single-line string** with correct formatting and appropriate escaping for new lines and indentation. For example, in the `fileContent` object, you see the actual multiline YAML content, which is not allowed ❌.
215+
- The YAML content must be passed as a **single-line string** with correct formatting and appropriate escaping for new lines and indentation. For example, in the following `fileContent` object, you see the actual multiline YAML content, which is not allowed ❌.
169216

170217
```jsx
171218
{
@@ -245,7 +292,7 @@ This endpoint allows you to overwrite existing files in your FlutterFlow project
245292
```
246293
:::info
247294
- In the `fileKeyToContent` object, you must provide the **entire content** of the file.
248-
- The YAML content must be passed as a **single-line string** with correct formatting and appropriate escaping for newlines and indentation. For example, in the `fileKeyToContent` object, you see the actual multiline YAML content, which is not allowed ❌.
295+
- The YAML content must be passed as a **single-line string** with correct formatting and appropriate escaping for newlines and indentation. For example, in the following `fileKeyToContent` object, you see the actual multiline YAML content, which is not allowed ❌.
249296

250297
```jsx
251298
{

0 commit comments

Comments
 (0)