Skip to content

Commit

Permalink
Update api.md to reflect latest API improvements
Browse files Browse the repository at this point in the history
Co-authored-by: Georgi Sabev <[email protected]>
  • Loading branch information
danail-branekov and georgethebeatle committed Sep 28, 2023
1 parent d0a8d33 commit 1db0295
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ No query parameters are supported.
- `names`
- `space_guids`
- `order_by` (the only supported value is `name`)
- `label_selector`

### [Delete an app](https://v3-apidocs.cloudfoundry.org/#delete-an-app)

Expand Down Expand Up @@ -121,16 +122,15 @@ Updating `image` is not supported.

### [Apply a manifest to a space](https://v3-apidocs.cloudfoundry.org/#apply-a-manifest-to-a-space)

Korifi only supports manifests with a single entry in `applications`.

#### Supported parameters:

- `applications[0].name`
- `applications[0].env`
- `applications[0].memory` (sets `memory` for the `web` process)
- `applications[0].processes`
- `applications[0].no-route`
- `applications[0].routes[0].route`
- `applications[].name`
- `applications[].env`
- `applications[].memory` (sets `memory` for the `web` process)
- `applications[].processes`
- `applications[].no-route`
- `applications[].routes[].route`
- `applications[].services` (user-provided services only)

### [Create a manifest diff for a space](https://v3-apidocs.cloudfoundry.org/#create-a-manifest-diff-for-a-space-experimental)

Expand All @@ -145,6 +145,8 @@ Korifi only supports manifests with a single entry in `applications`.

- `name`

### [Get an organization](https://v3-apidocs.cloudfoundry.org/#get-an-organization)

### [List organizations](https://v3-apidocs.cloudfoundry.org/#list-organizations)

#### Supported query parameters:
Expand Down Expand Up @@ -333,9 +335,11 @@ Korifi only supports user-provided service instances. Managed service operations

#### Supported query parameters:

- `guids`
- `names`
- `space_guids`
- `order_by` (the only supported values are `name`, `created_at` and `updated_at`)
- `label_selector`

### [Delete a service instance](https://v3-apidocs.cloudfoundry.org/#delete-a-service-instance)

Expand All @@ -362,6 +366,7 @@ No query parameters are supported.
- `app_guids`
- `type`
- `include` (the only supported value is `app`)
- `label_selector`

### [Delete a service credential binding](https://v3-apidocs.cloudfoundry.org/#delete-a-service-credential-binding)

Expand Down Expand Up @@ -400,6 +405,8 @@ This endpoint is fully supported.

### [Delete a space](https://v3-apidocs.cloudfoundry.org/#delete-a-space)

### [Get a space](https://v3-apidocs.cloudfoundry.org/#get-a-space)

This endpoint is fully supported.

## [Tasks](https://v3-apidocs.cloudfoundry.org/#tasks)
Expand Down

0 comments on commit 1db0295

Please sign in to comment.