All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| create_resource | POST /v2/schema/{proj_id}/{env_id}/resources | Create Resource |
| delete_resource | DELETE /v2/schema/{proj_id}/{env_id}/resources/{resource_id} | Delete Resource |
| get_resource | GET /v2/schema/{proj_id}/{env_id}/resources/{resource_id} | Get Resource |
| list_resources | GET /v2/schema/{proj_id}/{env_id}/resources | List Resources |
| replace_resource | PUT /v2/schema/{proj_id}/{env_id}/resources/{resource_id} | Replace Resource |
| update_resource | PATCH /v2/schema/{proj_id}/{env_id}/resources/{resource_id} | Update Resource |
models::ResourceRead create_resource(proj_id, env_id, resource_create) Create Resource
Creates a new resource (a type of object you may protect with permissions).
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| proj_id | String | Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug"). | [required] | |
| env_id | String | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug"). | [required] | |
| resource_create | ResourceCreate | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_resource(proj_id, env_id, resource_id) Delete Resource
Deletes the resource and all its related data.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| proj_id | String | Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug"). | [required] | |
| env_id | String | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug"). | [required] | |
| resource_id | String | Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the "slug"). | [required] |
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::ResourceRead get_resource(proj_id, env_id, resource_id) Get Resource
Gets a single resource, if such resource exists.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| proj_id | String | Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug"). | [required] | |
| env_id | String | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug"). | [required] | |
| resource_id | String | Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the "slug"). | [required] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::ResponseListResourcesV2SchemaProjIdEnvIdResourcesGet list_resources(proj_id, env_id, include_built_in, include_total_count, page, per_page, search) List Resources
Lists all the resources defined in your schema.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| proj_id | String | Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug"). | [required] | |
| env_id | String | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug"). | [required] | |
| include_built_in | Option<bool> | Whether to include or exclude built-in resources, default is False | [default to false] | |
| include_total_count | Option<bool> | Include total count in response | [default to false] | |
| page | Option<i32> | Page number of the results to fetch, starting at 1. | [default to 1] | |
| per_page | Option<i32> | The number of results per page (max 100). | [default to 30] | |
| search | Option<String> | Text search for the object name or key |
models::ResponseListResourcesV2SchemaProjIdEnvIdResourcesGet
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::ResourceRead replace_resource(proj_id, env_id, resource_id, resource_replace) Replace Resource
Completely replaces the resource definition. - If the resource key is changed, all role and permissions assignments for the the resource will be revoked. - If the resource key is unchanged, but some actions are removed or renamed from the resource definition, role and permissions assignments for these actions will be revoked. TODO: we need to decide if we are auto-revoking, or if we are rejecting the PUT completely while there are permissions that can be affected.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| proj_id | String | Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug"). | [required] | |
| env_id | String | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug"). | [required] | |
| resource_id | String | Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the "slug"). | [required] | |
| resource_replace | ResourceReplace | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::ResourceRead update_resource(proj_id, env_id, resource_id, resource_update) Update Resource
Partially updates the resource definition. Fields that will be provided will be completely overwritten.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| proj_id | String | Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug"). | [required] | |
| env_id | String | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug"). | [required] | |
| resource_id | String | Either the unique id of the resource, or the URL-friendly key of the resource (i.e: the "slug"). | [required] | |
| resource_update | ResourceUpdate | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]