diff --git a/README.md b/README.md index 2d520c7..bcda83f 100644 --- a/README.md +++ b/README.md @@ -18,37 +18,57 @@ Methods of the `NeonAPI` class: - `api_keys()`: Returns a list of API keys. - `api_key_create(**json)`: Creates an API key. - `api_key_delete(key_id)`: Deletes a given API key. + +Manage projects: + - `projects()`: Returns a list of projects. - `project(project_id)`: Returns a specific project. - `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. + +Manage branches: + - `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. + +Manage databases: + - `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. + +Manage endpoints: + - `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. + +Manage roles: + - `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. + +Manage operations: + - `operations(project_id)`: Returns a list of operations for a given project. - `operation(project_id, operation_id)`: Returns a specific operation. -- `...` + + +View the [Neon API documentation](https://api-docs.neon.tech/reference/getting-started-with-neon-api) for more information on the available endpoints and their parameters. 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()`).