Skip to content

docs: mention we're adding an API example to the roadmap #32

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 2 commits into from
Mar 15, 2024
Merged

docs: mention we're adding an API example to the roadmap #32

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
408b300
mention we're adding API support to the roadmap
bpmct Mar 15, 2024
10eea7b
remove TODOs
bpmct Mar 15, 2024
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
21 changes: 1 addition & 20 deletions plugins/backstage-plugin-coder/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

Create and manage [Coder workspaces](https://coder.com/docs/v2/latest) from Backstage.

<!-- TOOD: Add Loom -->

## Screenshots

![Coder authentication](./screenshots/coder-auth.png)
Expand All @@ -15,7 +13,6 @@ Create and manage [Coder workspaces](https://coder.com/docs/v2/latest) from Back
- Users link their Coder accounts with Backstage via tokens
- Associate Coder workspaces with catalog items in Backstage
- Workspace list component for viewing and managing workspaces
<!-- - Full Coder API access for custom plugins & integrations -->

## Setup

Expand Down Expand Up @@ -104,27 +101,11 @@ the Dev Container.
</Grid>;
```

<!-- Individual components of the card can also be imported. See [the plugin documentation](./docs) for full configuration options and API reference. -->

<!-- ### API Access

The plugin provides a `CoderApi` instance for accessing the Coder API. This can be used in custom plugins and integrations. Here is an example component that lists all templates:

```tsx
import { useCoder } from '@coder/backstage-plugin-coder';

// TODO. I believe Michael said this is possible today?
// This can be a very basic component that requires auth
// and lists all templates in a basic unstyled list
// with a refresh button
```

See to the [Coder REST API Reference](https://coder.com/docs/v2/latest/api) for more details -->

## Roadmap

This plugin is in active development. The following features are planned:

- [ ] Example component using the Coder API to make authenticated requests on behalf of the user
- [ ] Add support for only rendering component if `catalog-info.yaml` indicates the item is compatible with Coder
- [ ] OAuth support (vs. token auth) for linking Coder accounts
- [ ] "Open in Coder" button/card component for catalog items
Expand Down