openapi-starter/redocly.yaml at main · GreenButtonAlliance/openapi-starter · 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
56
57
58
# See https://redocly.com/docs/cli/configuration/ for more information.
apis:
  greenbutton@v1.1:
    root: openapi/openapi.yaml
extends:
  - recommended
rules:
  no-unused-components: error
  no-server-example.com: off
  struct: error
  # XML string examples for application/atom+xml cannot be validated against
  # JSON object schemas; these warnings are expected false positives.
  no-invalid-media-type-examples:
    severity: off

openapi:
  htmlTemplate: ./docs/index.html
  theme:
    colors:
      primary:
        main: "#10a54a"  # Green Button green
      success:
        main: "#10a54a"
      warning:
        main: "#f39c12"
      error:
        main: "#e74c3c"
      text:
        primary: "#263238"
        secondary: "#5f6c72"
      http:
        get: "#10a54a"
        post: "#3498db"
        put: "#f39c12"
        delete: "#e74c3c"
    typography:
      fontSize: "16px"
      fontFamily: '"Open Sans", sans-serif'
      headings:
        fontFamily: '"Montserrat", sans-serif'
        fontWeight: "600"
      code:
        fontSize: "14px"
        fontFamily: '"Source Code Pro", monospace'
    sidebar:
      backgroundColor: "#fafafa"
      textColor: "#263238"
      activeTextColor: "#10a54a"
    rightPanel:
      backgroundColor: "#263238"
      textColor: "#ffffff"
  generateCodeSamples:
    languages:  # Array of language config objects; indicates in which languages to generate code samples.
      - lang: curl
      - lang: Node.js
      - lang: JavaScript
      - lang: PHP
      - lang: Python