Skip to content

Commit 539cd53

Browse files
changed /updateProjectYaml to /updateProjectByYaml (#441)
* changed /updateProjectYaml to /updateProjectByYaml * addressed additional typos --------- Co-authored-by: Pooja Bhaumik <[email protected]>
1 parent bf47a97 commit 539cd53

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -103,13 +103,13 @@ Authorization: Bearer YOUR_API_TOKEN_HERE
103103
## API Endpoints
104104
Below is a list of available API endpoints with their methods and usage descriptions.
105105

106-
| Endpoint | Method | Purpose |
107-
| --------------------------- | ------ | --------------------------------------------- |
108-
| `/listPartitionedFileNames` | GET | List available YAML file names for a project. |
109-
| `/l/listProjects` | POST | Retrieve metadata for all projects. |
110-
| `/projectYamls` | GET | Export/download YAML files from a project. |
111-
| `/validateProjectYaml` | POST | Validate YAML content before applying changes. |
112-
| `/updateProjectYaml` | POST | Update project configuration via YAML. |
106+
| Endpoint | Method | Purpose |
107+
| --------------------------- | ------ | --------------------------------------------- |
108+
| `/listPartitionedFileNames` | GET | List available YAML file names for a project. |
109+
| `/l/listProjects` | POST | Retrieve metadata for all projects. |
110+
| `/projectYamls` | GET | Export/download YAML files from a project. |
111+
| `/validateProjectYaml` | POST | Validate YAML content before applying changes. |
112+
| `/updateProjectByYaml` | POST | Update project configuration via YAML. |
113113

114114

115115
### List File Names
@@ -358,7 +358,7 @@ curl -X POST \
358358
This endpoint allows you to overwrite existing files in your FlutterFlow project by submitting updated YAML content.
359359

360360
#### Endpoint
361-
`POST /updateProjectYaml`
361+
`POST /updateProjectByYaml`
362362

363363
#### Request Body
364364
```jsx
@@ -413,7 +413,7 @@ This example updates the `ad-mob` file and adds/updates app state variables.
413413

414414
```jsx
415415
curl -X POST \
416-
'https://api.flutterflow.io/v2/updateProjectYaml' \
416+
'https://api.flutterflow.io/v2/updateProjectByYaml' \
417417
-H 'Authorization: Bearer YOUR_API_TOKEN' \
418418
-H 'Content-Type: application/json' \
419419
-d '{
@@ -462,7 +462,7 @@ First, we use the `/listPartitionedFileNames` endpoint to check if the `app-stat
462462
</div>
463463
<p></p>
464464

465-
Next, we open the `app-state.yaml` file and update the `enableDarkMode` variable by setting its `persisted` value to `true`. We then convert the updated YAML into a properly escaped single line string and validate it using the `/validateProjectYaml` endpoint. If validation succeeds, we send the final update using the `/updateProjectYaml` endpoint.
465+
Next, we open the `app-state.yaml` file and update the `enableDarkMode` variable by setting its `persisted` value to `true`. We then convert the updated YAML into a properly escaped single line string and validate it using the `/validateProjectYaml` endpoint. If validation succeeds, we send the final update using the `/updateProjectByYaml` endpoint.
466466

467467

468468
<div style={{
@@ -535,7 +535,7 @@ When YAML validation fails, you'll receive detailed error information:
535535
-d '{"projectId": "project-id", "fileKey": "ad-mob", "fileContent": "showTestAds: false"}'
536536
537537
# 2. If validation passes, apply the changes
538-
curl -X POST 'https://api.flutterflow.io/v2/updateProjectYaml' \
538+
curl -X POST 'https://api.flutterflow.io/v2/updateProjectByYaml' \
539539
-H 'Authorization: Bearer YOUR_API_KEY' \
540540
-H 'Content-Type: application/json' \
541541
-d '{"projectId": "project-id", "fileKeyToContent": {"ad-mob": "showTestAds: false"}}'

0 commit comments

Comments
 (0)