class Detector::Specification::Oas2

Defined in:

detector/detectors/specification/oas2.cr

Constant Summary

SWAGGER2_JSON_MARKER = /"swagger"[ \t]*:[ \t]*"2\./
SWAGGER2_YAML_MARKER = /^["']?swagger["']?[ \t]*:[ \t]*["']?2\./m

See Detector::Specification::Oas3 for why the YAML gate is anchored at column 0 and stands in for the parse. A bare /swagger/ matched every OpenAPI 3 document that links to its own swagger.yaml origin — 67 of the 493 openapi-directory documents in the perf corpus — and each one paid for a full YAML parse only to be rejected.

Class Method Summary

Instance Method Summary

Instance methods inherited from class Detector

applicable?(filename : String) : Bool applicable?, base_relative_path(filename : String) : String base_relative_path, content_matches?(file_contents : String, markers : Regex) : Bool content_matches?, detect(filename : String, file_contents : String) : Bool detect, gemfile_dependency?(file_contents : String, gem_name : String) : Bool gemfile_dependency?, gemspec_dependency?(file_contents : String, gem_name : String) : Bool gemspec_dependency?, idempotent? : Bool idempotent?, logger : NoirLogger logger, name : String name, path_sensitive? : Bool path_sensitive?

Constructor methods inherited from class Detector

new(options : Hash(String, YAML::Any)) new

Macros inherited from class Detector

detector_for(tech, extensions = nil, basenames = nil, path_segments = nil, idempotent = nil) detector_for

Class Method Detail

def self.tech_name : String #

The tech name without needing an instance, so the registry can be read off the classes themselves rather than from a parallel list.


[View source]

Instance Method Detail

def applicable?(filename : String) : Bool #

Registers every OAS2 spec path in CodeLocator for the analyzer pass. Must keep running after first match.


[View source]
def detect(filename : String, file_contents : String) : Bool #

[View source]
def idempotent? : Bool #

Registers every OAS2 spec path in CodeLocator for the analyzer pass. Must keep running after first match.


[View source]
def set_name #

Registers every OAS2 spec path in CodeLocator for the analyzer pass. Must keep running after first match.


[View source]