bsctl/.bsctl.yaml.example at main · totte-dev/bsctl · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# Example bsctl configuration
# Copy to .bsctl.yaml or split into .bsctl/ directory
# See docs/plugin-definition.md for full reference

plugins:
  # Example: wrap a custom Backstage plugin API
  todo:
    list:
      method: GET
      path: /api/todo/todos
      description: List TODO items
    add:
      method: POST
      path: /api/todo/todos
      description: Create a TODO item
      params:
        - name: title
          body: title
          required: true
        - name: entity-ref
          body: entityRef

  # Example: GitHub Actions integration
  actions:
    runs:
      method: GET
      path: /api/proxy/github/actions/runs
      description: List recent workflow runs
    run:
      method: GET
      path: /api/proxy/github/actions/runs/{id}
      description: Get workflow run details
      args:
        - name: id
          position: 1

# Custom columns per entity type for `catalog list -t <type>`
# Use `bsctl columns generate -t <type> --write` to auto-generate
columns:
  service:
    - header: On-Call
      path: metadata.annotations.pagerduty.com/service-id
    - header: Language
      path: metadata.annotations.backstage.io/language
  website:
    - header: Environment
      path: metadata.annotations.example.com/environment
      style: env
    - header: URL
      path: metadata.annotations.example.com/url