kennethreitz/neon-api-python
1
0
Fork 0
mirror of https://github.com/kennethreitz/neon-api-python.git synced 2026-06-05 22:50:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactor NeonClient methods in readme to include project and branch parameters

Browse Source
This commit is contained in:
Kenneth Reitz
2024-01-21 18:35:55 -05:00
parent 3aa849ff82
commit 960644bb3d
1 changed files with 25 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+25 -25
View File
@@ -20,31 +20,31 @@ Methods of `NeonClient`:
- `project_create(project_id, json)`: Creates a new project.
- `project_update(project_id, json)`: Updates a given project.
- `project_delete(project_id)`: Deletes a given project.
- `branches(project_id)`
- `branch(project_id, branch_id)`
- `branch_create(project_id, **json)`
- `branch_update(project_id, branch_id, **json)`
- `branch_delete(project_id, branch_id)`
- `branch_set_as_primary(project_id, branch_id)`
- `databases(project_id, branch_id)`
- `database(project_id, branch_id, database_id)`
- `database_create(project_id, branch_id, **json)`
- `database_update(project_id, branch_id, **json)`
- `database_delete(project_id, branch_id, database_id)`
- `endpoints()`
- `endpoint_create()`
- `endpoint_update()`
- `endpoint_delete()`
- `endpoint_start()`
- `endpoint_suspend()`
- `role()`
- `roles()`
- `role_create()`
- `role_delete()`
- `role_password_reveal()`
- `role_password_reset()`
- `operations()`
- `operation()`
- `branches(project_id)`: Returns a list of branches for a given project.
- `branch(project_id, branch_id)`: Returns a specific branch.
- `branch_create(project_id, **json)`: Creates a new branch.
- `branch_update(project_id, branch_id, **json)`: Updates a given branch.
- `branch_delete(project_id, branch_id)`: Deletes a given branch.
- `branch_set_as_primary(project_id, branch_id)`: Sets a given branch as primary.
- `databases(project_id, branch_id)`: Returns a list of databases for a given project and branch.
- `database(project_id, branch_id, database_id)`: Returns a specific database.
- `database_create(project_id, branch_id, **json)`: Creates a new database.
- `database_update(project_id, branch_id, **json)`: Updates a given database.
- `database_delete(project_id, branch_id, database_id)`: Deletes a given database.
- `endpoints(project_id, branch_id)`: Returns a list of endpoints for a given project and branch.
- `endpoint_create(project_id, branch_id, **json)`: Creates a new endpoint.
- `endpoint_update(project_id, branch_id, endpoint_id, **json)`: Updates a given endpoint.
- `endpoint_delete(project_id, branch_id, endpoint_id)`: Deletes a given endpoint.
- `endpoint_start(project_id, branch_id, endpoint_id)`: Starts a given endpoint.
- `endpoint_suspend(project_id, branch_id, endpoint_id)`: Suspends a given endpoint.
- `roles(project_id, branch_id)`: Returns a list of roles for a given project and branch.
- `role(project_id, branch_id, role_name)`: Returns a specific role.
- `role_create(project_id, branch_id, role_name)`: Creates a new role.
- `role_delete(project_id, branch_id, role_name)`: Deletes a given role.
- `role_password_reveal(project_id, branch_id, role_name)`: Reveals the password for a given role.
- `role_password_reset(project_id, branch_id, role_name)`: Resets the password for a given role.
- `operations(project_id)`: Returns a list of operations for a given project.
- `operation(project_id, operation_id)`: Returns a specific operation.
- `...`
Remember that you should never expose your api_key and handle it carefully since it gives access to sensitive data. It's better to set it as an environment variable (e.g. `NEON_API_KEY` + accompanying `neon_client.from_environ()`).