JuliaComputing / OpenAPI.jl

OpenAPI helper and code generator for Julia
Other
43 stars 8 forks source link

add convenience method for linting #53

Closed tanmaykm closed 1 year ago

tanmaykm commented 1 year ago

Spectral is an open-source API style guide enforcer and linter. This adds a convenience method for linting in Julia using spectral.

OpenAPI.lint(
    spec::AbstractString;   # the OpenAPI specification to use
    use_sudo::Bool=false    # whether to use sudo while invoking docker
)

OpenAPI.lint(
    spec_dir::AbstractString;   # folder containing the specification file
    spec_file::AbstractString;  # the specification file
    use_sudo::Bool=false        # whether to use sudo while invoking docker
)