SWAMPy

✎ CARVE FLESH

EDITING: api_routes.rb

# frozen_string_literal: true

#
# Copyright (C) 2011 Instructure, Inc.
#
# This file is part of Canvas.
#
# Canvas is free software: you can redistribute it and/or modify it under
# the terms of the GNU Affero General Public License as published by the Free
# Software Foundation, version 3 of the License.
#
# Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
# details.
#
# You should have received a copy of the GNU Affero General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.
#

require "bundler"
Bundler.setup
require "action_controller"

# load the routes
if CanvasRails::Application.routes_reloader.paths.empty?
  require_relative "../../lib/api_route_set"
  require_relative "../../lib/token_scopes_helper"
  # we need this for a route constraint
  require_relative "../../lib/lti/re_reg_constraint"

routes_files = CanvasRails::Application.paths["config/routes.rb"].existent +
                 CanvasRails::Application.railties.map do |railtie|
                   next unless railtie.is_a?(Rails::Engine)

railtie.paths["config/routes.rb"].existent
                 end.flatten

CanvasRails::Application.routes.disable_clear_and_finalize = true
  CanvasRails::Application.routes.clear!

routes_files.compact.each { |path| load(path) }
else
  # we're probably running in spring, and Rails has already loaded them; make
  # sure they're up to date
  CanvasRails::Application.routes_reloader.reload!
end

# Extend YARD to generate our API documentation
YARD::Tags::Library.define_tag("Is an API method", :API)
YARD::Tags::Library.define_tag("API method argument", :argument)
# Expected Format:
# @deprecated_argument argument_name NOTICE YYYY-MM-DD EFFECTIVE YYYY-MM-DD
#   A description of the deprecation. (required)
YARD::Tags::Library.define_tag("API method argument is deprecated", :deprecated_argument)
# Expected Format:
# @deprecated_method NOTICE YYYY-MM-DD EFFECTIVE YYYY-MM-DD
#   Use {api:FooController#some_action Foo#some_action} instead. A description of the deprecated method. (required)
YARD::Tags::Library.define_tag("API method is deprecated", :deprecated_method)
YARD::Tags::Library.define_tag("API response field", :request_field)
YARD::Tags::Library.define_tag("API response field", :response_field)
# Expected Format:
# @deprecated_response_field response_field NOTICE YYYY-MM-DD EFFECTIVE YYYY-MM-DD
#   A description of the deprecation. (required)
YARD::Tags::Library.define_tag("API response field is deprecated", :deprecated_response_field)
YARD::Tags::Library.define_tag("API example request", :example_request)
YARD::Tags::Library.define_tag("API example response", :example_response)
YARD::Tags::Library.define_tag("API subtopic", :subtopic)
YARD::Tags::Library.define_tag("API resource is Beta", :beta)
YARD::Tags::Library.define_tag("API Object Definition", :object)
YARD::Tags::Library.define_tag("API Return Type", :returns)
YARD::Tags::Library.define_tag("API resource is internal", :internal)

module YARD::Templates::Helpers
  module BaseHelper
    def run_verifier(list)
      list.select { |o| relevant_object?(o) }
    end

def relevant_object?(object)
      case object.type
      when :root, :module, :constant
        false
      when :method, :class
        !object.tags("API").empty? && (ENV["INCLUDE_INTERNAL"] || object.tags("internal").empty?)
      else
        if object.parent.nil?
          false
        else
          relevant_object?(object.parent)
        end
      end
    end
  end
end

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📁 appendix/	DIR	—	2023-09-24 03:36
📁 data_services/	DIR	—	2023-09-24 03:36
📁 docstring/	DIR	—	2023-09-24 03:36
📁 fulldoc/	DIR	—	2023-09-24 03:36
📁 layout/	DIR	—	2023-09-24 03:36
📁 method_details/	DIR	—	2023-09-24 03:36
📁 tags/	DIR	—	2023-09-24 03:36
📁 topic/	DIR	—	2023-09-24 03:36
📄 api_routes.rb	RB	3.6 KB	2023-09-24 03:36	EDIT
📄 assignment_external_tools.md	MD	3 KB	2023-09-24 03:36	EDIT
📄 assignment_selection_placement.md	MD	5.9 KB	2023-09-24 03:36	EDIT
📄 assignment_tools.md	MD	22.8 KB	2023-09-24 03:36	EDIT
📄 canvas_roles.md	MD	7 KB	2023-09-24 03:36	EDIT
📄 changelog.md	MD	272 B	2023-09-24 03:36	EDIT
📄 collaborations_placement.md	MD	2.4 KB	2023-09-24 03:36	EDIT
📄 compound_documents.md	MD	1.6 KB	2023-09-24 03:36	EDIT
📄 content_item.md	MD	16.6 KB	2023-09-24 03:36	EDIT
📄 developer_keys.md	MD	7.1 KB	2023-09-24 03:36	EDIT
📄 editor_button_placement.md	MD	5.6 KB	2023-09-24 03:36	EDIT
📄 editor_button_tools.md	MD	9.5 KB	2023-09-24 03:36	EDIT
📄 endpoint_attributes.md	MD	1 KB	2023-09-24 03:36	EDIT
📄 file_uploads.md	MD	10.6 KB	2023-09-24 03:36	EDIT
📄 graphql.md	MD	4.4 KB	2023-09-24 03:39	EDIT
📄 group_category_csv.md	MD	2.7 KB	2023-09-24 03:36	EDIT
📄 homework_submission_placement.md	MD	5 KB	2023-09-24 03:36	EDIT
📄 homework_submission_tools.md	MD	5.5 KB	2023-09-24 03:36	EDIT
📄 jwt_access_tokens.md	MD	6.5 KB	2023-09-24 03:36	EDIT
📄 link_selection_placement.md	MD	5.6 KB	2023-09-24 03:36	EDIT
📄 link_selection_tools.md	MD	4.6 KB	2023-09-24 03:36	EDIT
📄 lti_dev_key_config.md	MD	31.1 KB	2023-09-24 03:39	EDIT
📄 lti_window_post_message.md	MD	13.2 KB	2023-09-24 03:39	EDIT
📄 masquerading.md	MD	1.2 KB	2023-09-24 03:36	EDIT
📄 migration_selection_placement.md	MD	4.5 KB	2023-09-24 03:36	EDIT
📄 navigation_tools.md	MD	14.9 KB	2023-09-24 03:36	EDIT
📄 oauth.md	MD	16.3 KB	2023-09-24 03:36	EDIT
📄 oauth_endpoints.md	MD	15.8 KB	2023-09-24 03:36	EDIT
📄 object_ids.md	MD	2.9 KB	2023-09-24 03:36	EDIT
📄 originality_report_appendix.md	MD	854 B	2023-09-24 03:36	EDIT
📄 outcomes_csv.md	MD	5.6 KB	2023-09-24 03:39	EDIT
📄 pagination.md	MD	1.6 KB	2023-09-24 03:36	EDIT
📄 plagiarism_platform.md	MD	23.8 KB	2023-09-24 03:36	EDIT
📄 provisioning.md	MD	7.7 KB	2023-09-24 03:39	EDIT
📄 README.md	MD	3.6 KB	2023-09-24 03:36	EDIT
📄 sis_csv.md	MD	35.9 KB	2023-09-24 03:39	EDIT
📄 subscriptions_appendix.md	MD	1.2 KB	2023-09-24 03:36	EDIT
📄 throttling.md	MD	1.6 KB	2023-09-24 03:36	EDIT
📄 tools_intro.md	MD	10 KB	2023-09-24 03:36	EDIT
📄 tools_variable_substitutions.head.md	MD	7.6 KB	2023-09-24 03:36	EDIT
📄 tools_variable_substitutions.md	MD	40.4 KB	2023-09-24 03:39	EDIT
📄 tools_xml.md	MD	46.3 KB	2023-09-24 03:36	EDIT
📄 xapi.md	MD	1.7 KB	2023-09-24 03:36	EDIT