CodeQL library for Ruby
codeql/ruby-all 5.1.10 (changelog, source)
Search

Module Grape

Provides modeling for Grape, a REST-like API framework for Ruby. Grape allows you to build RESTful APIs in Ruby with minimal effort.

Import path

import codeql.ruby.frameworks.Grape

Classes

GrapeApiClass

A class that extends Grape::API. For example,

GrapeCookiesSource

A call to cookies method from within a Grape API endpoint or cookies block. Similar to headers, cookies can be accessed as a method and are user-controlled input.

GrapeEndpoint

A Grape API endpoint (get, post, put, delete, etc.) call within a Grape::API class.

GrapeHeadersSource

A call to headers from within a Grape API endpoint or headers block. Headers can also be a source of user input.

GrapeParamsSource

A RemoteFlowSource::Range to represent accessing the Grape parameters available via the params method within an endpoint.

GrapeRequestSource

A call to request from within a Grape API endpoint. The request object can contain user input.

GrapeRouteParamSource

A call to route_param from within a Grape API endpoint. Route parameters are extracted from the URL path and can be a source of user input.

RootApi

A Grape API class which sits at the top of the class hierarchy. In other words, it does not subclass any other Grape API class in source code.