restlens-action/action.yml at master · Edthing/restlens-action · 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
51
52
53
54
55
name: 'REST Lens API Evaluation'
description: 'Evaluate OpenAPI specifications against REST Lens best practices and post results to PRs'
author: 'REST Lens'

branding:
  icon: 'check-circle'
  color: 'purple'

inputs:
  api-token:
    description: 'REST Lens project API token (create in project settings)'
    required: true
  spec-path:
    description: 'Path to the OpenAPI specification file (supports glob patterns)'
    required: true
  fail-on-error:
    description: 'Fail the action if any error-severity violations are found'
    required: false
    default: 'true'
  fail-on-warning:
    description: 'Fail the action if any warning-severity violations are found'
    required: false
    default: 'false'
  post-pr-comment:
    description: 'Post a summary comment on the PR (requires GitHub App installation)'
    required: false
    default: 'true'
  post-inline-comments:
    description: 'Post inline review comments on violations (requires GitHub App installation)'
    required: false
    default: 'true'
  api-url:
    description: 'REST Lens API base URL (for self-hosted instances)'
    required: false
    default: 'https://api.restlens.dev'

outputs:
  total-violations:
    description: 'Total number of violations found'
  error-count:
    description: 'Number of error-severity violations'
  warning-count:
    description: 'Number of warning-severity violations'
  info-count:
    description: 'Number of info-severity violations'
  evaluation-url:
    description: 'URL to view full evaluation results'
  comment-url:
    description: 'URL of the PR comment (if posted)'
  passed:
    description: 'Whether the evaluation passed (no violations above threshold)'

runs:
  using: 'node20'
  main: 'dist/index.js'