Skip to content

Integration API docs #2921

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 31, 2024
Merged

Integration API docs #2921

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 112 additions & 0 deletions docs/reference/replicated-sdk-apis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,118 @@ Response:
}
}
```

## Integration

### GET /api/v1/integration/status

Get status of Development Mode. When this mode is enabled, the `app` API will use mock data. This value cannot be set programmatically. It is controlled by the installed license.

```json
{
"isEnabled": true
}
```

### GET /api/v1/integration/mock-data

Get mock data that is used when Development Mode is enabled.

```json
{
"appStatus": "ready",
"helmChartURL": "oci://registry.replicated.com/dev-app/dev-channel/dev-parent-chart",
"currentRelease": {
"versionLabel": "0.1.3",
"releaseNotes": "release notes 0.1.3",
"createdAt": "2023-05-23T20:58:07Z",
"deployedAt": "2023-05-23T21:58:07Z",
"helmReleaseName": "dev-parent-chart",
"helmReleaseRevision": 3,
"helmReleaseNamespace": "default"
},
"deployedReleases": [
{
"versionLabel": "0.1.1",
"releaseNotes": "release notes 0.1.1",
"createdAt": "2023-05-21T20:58:07Z",
"deployedAt": "2023-05-21T21:58:07Z",
"helmReleaseName": "dev-parent-chart",
"helmReleaseRevision": 1,
"helmReleaseNamespace": "default"
},
{
"versionLabel": "0.1.2",
"releaseNotes": "release notes 0.1.2",
"createdAt": "2023-05-22T20:58:07Z",
"deployedAt": "2023-05-22T21:58:07Z",
"helmReleaseName": "dev-parent-chart",
"helmReleaseRevision": 2,
"helmReleaseNamespace": "default"
},
{
"versionLabel": "0.1.3",
"releaseNotes": "release notes 0.1.3",
"createdAt": "2023-05-23T20:58:07Z",
"deployedAt": "2023-05-23T21:58:07Z",
"helmReleaseName": "dev-parent-chart",
"helmReleaseRevision": 3,
"helmReleaseNamespace": "default"
}
],
"availableReleases": [
{
"versionLabel": "0.1.4",
"releaseNotes": "release notes 0.1.4",
"createdAt": "2023-05-24T20:58:07Z",
"deployedAt": "2023-05-24T21:58:07Z",
"helmReleaseName": "",
"helmReleaseRevision": 0,
"helmReleaseNamespace": ""
},
{
"versionLabel": "0.1.5",
"releaseNotes": "release notes 0.1.5",
"createdAt": "2023-06-01T20:58:07Z",
"deployedAt": "2023-06-01T21:58:07Z",
"helmReleaseName": "",
"helmReleaseRevision": 0,
"helmReleaseNamespace": ""
}
]
}
```

### POST /api/v1/integration/mock-data

Programmatically set mock data that is used when Development Mode is enabled. The payload will overwrite the existing mock data. Any data that is not included in the payload will be removed. For example, to remove release data, simply include empty arrays:

```
POST http://replicated:3000/api/v1/integration/mock-data
```

Request:

```json
{
"appStatus": "ready",
"helmChartURL": "oci://registry.replicated.com/dev-app/dev-channel/dev-parent-chart",
"currentRelease": {
"versionLabel": "0.1.3",
"releaseNotes": "release notes 0.1.3",
"createdAt": "2023-05-23T20:58:07Z",
"deployedAt": "2023-05-23T21:58:07Z",
"helmReleaseName": "dev-parent-chart",
"helmReleaseRevision": 3,
"helmReleaseNamespace": "default"
},
"deployedReleases": [],
"availableReleases": []
}
```

Response: Status `201` Created

## Examples

This section provides example use cases for the Replicated SDK API.
Expand Down
Loading