summaryrefslogtreecommitdiff
path: root/doc/ale-openapi.txt
blob: 27261de6de4be79f5bdde8dd2aff42b8edfa9d91 (plain)
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
===============================================================================
ALE OpenApi Integration                                     *ale-openapi-options*

===============================================================================
ibm-validator                                        *ale-openapi-ibm-validator*

Website: https://github.com/IBM/openapi-validator


Installation
-------------------------------------------------------------------------------

Install ibm-openapi-validator either globally or locally: >

  npm install ibm-openapi-validator -g  # global
  npm install ibm-openapi-validator     # local
<
Recommended plugin for openapi filetype detection:

  https://github.com/hsanson/vim-openapi

Options
-------------------------------------------------------------------------------

g:ale_openapi_ibm_validator_executable   *g:ale_openapi_ibm_validator_executable*
                                         *b:ale_openapi_ibm_validator_executable*
  Type: |String|
  Default: `'lint-openapi'`

  This variable can be set to change the path to lint-openapi.


g:ale_openapi_ibm_validator_options       *g:ale_openapi_ibm_validator_options*
                                          *b:ale_openapi_ibm_validator_options*
  Type: |String|
  Default: `''`

  This variable can be set to pass additional options to lint-openapi.


===============================================================================
prettier                                                   *ale-openapi-prettier*

See |ale-javascript-prettier| for information about the available options.


===============================================================================
yamllint                                                  *ale-openapi-yamllint*

See |ale-yaml-yamllint| for information about the available options.


===============================================================================
  vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: