docit 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ac8acf7fd2b736bb2c89c63a63bca482239783457d7572d864e0257a3a2c6cd
-  data.tar.gz: 1605b07b832dc73f4e7f00e0840aa72267cbb60262e17baba6842134ee576e19
+  metadata.gz: 85a7407aab5a5fea2aa0c679d469360f124884ebeac2e4479265cbcdd818210d
+  data.tar.gz: c946eea9c5a664931630b00726f33b8e5bb296c1493e799c67cd905f330cba1d
 SHA512:
-  metadata.gz: a72fa34e950fdf918daab680c287311401a4059fa3b8d0bf16a0ebcef210ed607b697d3ad58a3343bf7d105a2a11d717efd0f8ee239464a82f58ca5f934b1e79
-  data.tar.gz: 96516820d968faae672a4caa7b6c52c9d79356b6366d09edaa019badb2c6949c0b4087115e6f306f559904b5dbcb02b594c2e0e58e864458c0c460e381d4d894
+  metadata.gz: 3dd0a62c6d0f138916839a7bcc445f98921abaf9e0ef477473e4dddba67f2033fd29ffb51a4803597d98f0807ee24c53d6b5a90a8d144d87c54669ee51155fef
+  data.tar.gz: d953ceef06cd91034fa79503a07da386dcefc7cdddabcb3567d1638d6546a2c484bdebd82f263d732a94b89447a9e9f6b659d7008c322d2e238e002aca286a1b

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -11,7 +11,7 @@ A clear and concise description of the bug.
 ## Steps to Reproduce
 
 1. Configure Docit with `...`
-2. Add `swagger_doc` to `...`
+2. Add `doc_for` to `...`
 3. Visit `/api-docs`
 4. See error
 

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -17,7 +17,7 @@ Explain the problem this feature would solve or the workflow it would improve.
 Describe how you'd like it to work, including example DSL usage if applicable:
 
 ```ruby
-swagger_doc :index do
+doc_for :index do
   # your proposed syntax here
 end
 ```

data/CHANGELOG.md

@@ -1,4 +1,35 @@
-## [Unreleased]
+## [0.5.0] - 2026-05-31
+
+### Added
+- **System Map**: a local, deterministic architecture graph at `/api-docs/system` (JSON at `/api-docs/system.json`), built from Rails routes, controllers, actions, Docit docs coverage, schemas, models, and source-derived service/job/mailer nodes — no external service required
+- System Map navigation alongside the Scalar and Swagger UIs
+- Light and dark themes for the System Map (light by default), with a toolbar toggle persisted across visits
+- **Diagram view**: interactive architecture graph with drag-to-arrange, scroll-to-zoom, pan, fit-to-screen, and PNG export; click a node to inspect its connections, with neighbouring nodes highlighted; `/` focuses node search
+- Endpoints-section filter for the diagram (Users, Orders, …) that narrows the graph to one resource and everything it touches
+- **Docs view**: a request/response reference grouped by resource, with human-readable endpoint titles derived from doc summaries (falling back to REST conventions), a documentation-coverage indicator per section, and a detail panel showing parameters, request body, and responses
+- AI section explanations in the Docs view: "Explain section" summarises how a resource's endpoints work together, gated by a coverage warning so undocumented sections don't silently spend tokens
+
+## [0.4.0] - 2026-04-18
+
+### Added
+- `operation_id` DSL method: set a custom `operationId` per endpoint for cleaner SDK codegen
+- Auto-generated `operationId` for every endpoint (e.g., `index_users`, `login_auth`) when not explicitly set
+- `config.license` option: add license info (`name`, `url`) to the OpenAPI spec
+- `config.contact` option: add contact info (`name`, `email`, `url`) to the OpenAPI spec
+- `config.terms_of_service` option: add terms of service URL to the OpenAPI spec
+
+### Changed
+- Renamed `swagger_doc` DSL to `doc_for` (`swagger_doc` still works as a backward-compatible alias)
+
+### Fixed
+- `TagInjector` no longer crashes when `initializer_path` is nil
+- `docit:autodoc` rake task: removed broken `--dry-run` CLI flag (use `DRY_RUN=1` env var instead)
+- Fixed dummy app `auth_docs.rb` summary and request body to match integration test expectations
+
+## [0.3.1] - 2026-04-17
+
+### Fixed
+- Fixed gem packaging: `doc_block_validator.rb` was missing from the published 0.3.0 gem, causing `LoadError` on require
 
 ## [0.3.0] - 2026-04-16
 
@@ -51,7 +82,7 @@
 ## [0.1.0] - 2026-04-08
 
 - Initial release
-- DSL: `swagger_doc` macro for inline controller documentation
+- DSL: `doc_for` macro for inline controller documentation
 - DSL: `use_docs` + `Docit::DocFile` for separate doc files
 - Builders: request body, response, and parameter builders with nested object/array support
 - Schema `$ref` components via `Docit.define_schema`

data/CONTRIBUTING.md

@@ -55,7 +55,7 @@ bundle exec rspec spec/docit/v2_features_spec.rb:30
 lib/docit.rb                          # Entry point, configuration, schema registry
 lib/docit/configuration.rb            # Config class (title, auth, tags)
 lib/docit/registry.rb                 # Global operation store
-lib/docit/dsl.rb                      # swagger_doc macro
+lib/docit/dsl.rb                      # doc_for macro
 lib/docit/operation.rb                # Single endpoint documentation
 lib/docit/builders/                   # DSL builders (response, request_body, parameter)
 lib/docit/schema_definition.rb        # Reusable $ref schema definitions

data/README.md

@@ -11,6 +11,8 @@ Decorator-style API documentation for Ruby on Rails. Write OpenAPI 3.0.3 docs wi
 ### Swagger
 ![Swagger UI](docs/images/swagger_image.png)
 
+> **Full documentation:** [doc-it.dev/docs](https://doc-it.dev/docs)
+
 ## Table Of Contents
 
 - Getting started
@@ -39,6 +41,7 @@ Decorator-style API documentation for Ruby on Rails. Write OpenAPI 3.0.3 docs wi
   - [What the AI generates](#what-the-ai-generates)
 - Runtime and development
   - [Documentation UIs](#documentation-uis)
+  - [System Map](#system-map)
   - [How it works](#how-it-works)
   - [Mounting at a different path](#mounting-at-a-different-path)
   - [JSON spec only](#json-spec-only)
@@ -105,6 +108,15 @@ Docit.configure do |config|
   config.server "https://api.example.com", description: "Production"
   config.server "https://staging.example.com", description: "Staging"
   config.server "http://localhost:3000", description: "Development"
+
+  # License information:
+  config.license name: "MIT", url: "https://opensource.org/licenses/MIT"
+
+  # Contact information:
+  config.contact name: "API Team", email: "api@example.com", url: "https://example.com/support"
+
+  # Terms of service:
+  config.terms_of_service "https://example.com/tos"
 end
 ```
 
@@ -114,11 +126,11 @@ Docit supports two styles for documenting endpoints. Choose whichever fits your
 
 ### Style 1: Inline (simple APIs)
 
-Add `swagger_doc` blocks directly in your controller:
+Add `doc_for` blocks directly in your controller:
 
 ```ruby
 class Api::V1::UsersController < ApplicationController
-  swagger_doc :index do
+  doc_for :index do
     summary "List all users"
     tags "Users"
     response 200, "Users retrieved"
@@ -129,6 +141,8 @@ class Api::V1::UsersController < ApplicationController
 end
 ```
 
+> **Upgrading?** The previous `swagger_doc` method still works as an alias for `doc_for`, so existing code won't break.
+
 ### Style 2: Separate doc files (recommended for larger APIs)
 
 Keep controllers clean by defining docs in dedicated files:
@@ -189,13 +203,13 @@ class Api::V1::UsersController < ApplicationController
 end
 ```
 
-You can also mix both styles — use `use_docs` for most actions and add inline `swagger_doc` for one-offs:
+You can also mix both styles — use `use_docs` for most actions and add inline `doc_for` for one-offs:
 
 ```ruby
 class Api::V1::UsersController < ApplicationController
   use_docs Api::V1::UsersDocs        # loads :index and :create from doc file
 
-  swagger_doc :destroy do             # inline doc for this one action
+  doc_for :destroy do             # inline doc for this one action
     summary "Delete user"
     tags "Users"
     response 204, "Deleted"
@@ -209,12 +223,12 @@ end
 
 ### Endpoint documentation DSL
 
-The following examples work in both `swagger_doc` blocks and `doc` blocks.
+The following examples work in both `doc_for` blocks and `doc` blocks.
 
 ### Request bodies
 
 ```ruby
-swagger_doc :create do
+doc_for :create do
   summary "Create a user"
   tags "Users"
 
@@ -247,7 +261,7 @@ end
 ### Path parameters
 
 ```ruby
-swagger_doc :show do
+doc_for :show do
   summary "Get a user"
   tags "Users"
 
@@ -271,7 +285,7 @@ end
 ### Enums
 
 ```ruby
-swagger_doc :index do
+doc_for :index do
   summary "List orders"
   tags "Orders"
 
@@ -293,7 +307,7 @@ end
 Mark endpoints as requiring authentication:
 
 ```ruby
-swagger_doc :destroy do
+doc_for :destroy do
   summary "Delete a user"
   tags "Users"
   security :bearer_auth      # references the scheme from your config
@@ -306,7 +320,7 @@ end
 ### Deprecated endpoints
 
 ```ruby
-swagger_doc :legacy_search do
+doc_for :legacy_search do
   summary "Search (legacy)"
   tags "Search"
   deprecated
@@ -373,7 +387,7 @@ end
 Reference them in any endpoint with `schema ref:`:
 
 ```ruby
-swagger_doc :show do
+doc_for :show do
   summary "Get user"
   tags "Users"
 
@@ -386,7 +400,7 @@ swagger_doc :show do
   end
 end
 
-swagger_doc :create do
+doc_for :create do
   summary "Create user"
   tags "Users"
 
@@ -407,7 +421,7 @@ This outputs `$ref: '#/components/schemas/User'` in the spec — Swagger UI reso
 Use `type: :file` with `content_type: "multipart/form-data"` for file upload endpoints:
 
 ```ruby
-swagger_doc :upload_avatar do
+doc_for :upload_avatar do
   summary "Upload avatar"
   tags "Users"
 
@@ -486,15 +500,28 @@ Docit ships with two documentation UIs, both reading from the same OpenAPI spec:
 | `/api-docs` | Default (Scalar) | Configurable via `config.default_ui` |
 | `/api-docs/scalar` | Scalar API Reference | Modern UI with built-in API client, dark mode, code samples |
 | `/api-docs/swagger` | Swagger UI | Classic OpenAPI explorer |
+| `/api-docs/system` | System Map | Local architecture graph for routes, controllers, docs coverage, and app structure |
 | `/api-docs/spec` | Raw JSON | OpenAPI 3.0.3 spec |
 
 Both UIs include a navigation bar to switch between them. Set `config.default_ui = :swagger` to make Swagger the default at `/api-docs`.
 
+## System Map
+
+Docit includes a local system map for understanding how your Rails API fits together. It builds a **deterministic** graph from Rails routes, controller actions, Docit docs, schemas, models, and source references — no external service is required to view it.
+
+Visit `/api-docs/system` to open it. It has two views, a light/dark theme toggle, and PNG export:
+
+- **Diagram** — an interactive architecture graph. Drag nodes to rearrange, scroll to zoom, and click a node to inspect its connections (its neighbours highlight while the rest fade back). Filter to a single resource with the section dropdown, or press `/` to search nodes.
+- **Docs** — a request/response reference grouped by resource. Each endpoint shows a human-readable title, its method and path, parameters, request body, and responses, drawn from your Docit docs. A coverage indicator shows how many endpoints in each section are documented.
+
+If you have an AI provider configured, the Docs view's **Explain section** button summarises how a resource's endpoints work together. It warns before running on sections with undocumented endpoints, so documenting first gives a better result.
+
 ## How it works
 
-1. `swagger_doc` registers an **Operation** for each controller action in a global **Registry**
+1. `doc_for` registers an **Operation** for each controller action in a global **Registry**
 2. When someone visits `/api-docs/spec`, Docit's **SchemaGenerator** combines all registered operations with your Rails routes (via **RouteInspector**) to produce an OpenAPI 3.0.3 JSON document
 3. The **Engine** serves the configured documentation UI at `/api-docs`, pointing it at the generated spec
+4. The **SystemGraph** builds a local architecture graph for `/api-docs/system`
 
 The DSL is included in all controllers automatically via a Rails Engine initializer — no manual `include` needed if you're using `ActionController::API` or `ActionController::Base`.
 

data/app/controllers/docit/ui_controller.rb

@@ -16,6 +16,31 @@ module Docit
       render_ui(:scalar)
     end
 
+    def system
+      render_ui(:system)
+    end
+
+    def system_spec
+      unless Docit.configuration.system_graph_enabled
+        return render(json: { error: "System graph disabled" }, status: :not_found)
+      end
+
+      RouteInspector.eager_load_controllers!
+      render json: SystemGraph::Generator.generate
+    end
+
+    def system_insights
+      graph = system_graph
+      insight = Ai::SystemInsightGenerator.new(
+        graph: graph,
+        selected_node_ids: selected_node_ids,
+        mode: insight_mode
+      ).generate
+      render json: { insight: insight }
+    rescue Docit::Error => e
+      render json: { error: e.message }, status: :unprocessable_entity
+    end
+
     def spec
       RouteInspector.eager_load_controllers!
       render json: SchemaGenerator.generate
@@ -25,21 +50,50 @@ module Docit
 
     RENDERERS = {
       swagger: UI::SwaggerRenderer,
-      scalar: UI::ScalarRenderer
+      scalar: UI::ScalarRenderer,
+      system: UI::SystemRenderer
     }.freeze
 
     def render_ui(ui_name)
-      renderer = RENDERERS.fetch(ui_name).new(spec_url: spec_url, nav_paths: nav_paths)
+      renderer = RENDERERS.fetch(ui_name).new(
+        spec_url: spec_url,
+        system_url: system_url,
+        system_insights_url: system_insights_url,
+        nav_paths: nav_paths
+      )
       render html: renderer.render.html_safe, layout: false
     end
 
+    def system_graph
+      RouteInspector.eager_load_controllers!
+      SystemGraph::Generator.generate
+    end
+
+    def selected_node_ids
+      params.fetch(:node_ids, "").to_s.split(",").reject(&:empty?)
+    end
+
+    # Validate at the boundary: only the known modes are honored, anything
+    # else falls back to the safe per-node default.
+    def insight_mode
+      params[:mode].to_s == "section" ? :section : :nodes
+    end
+
     def spec_url
       "#{request.base_url}#{Docit::Engine.routes.url_helpers.spec_path}"
     end
 
+    def system_url
+      "#{request.base_url}#{Docit::Engine.routes.url_helpers.system_spec_path}"
+    end
+
+    def system_insights_url
+      "#{request.base_url}#{Docit::Engine.routes.url_helpers.system_insights_path}"
+    end
+
     def nav_paths
       helpers = Docit::Engine.routes.url_helpers
-      { swagger: helpers.swagger_path, scalar: helpers.scalar_path }
+      { swagger: helpers.swagger_path, scalar: helpers.scalar_path, system: helpers.system_path }
     end
   end
 end

data/config/routes.rb

@@ -4,5 +4,8 @@ Docit::Engine.routes.draw do
   root to: "ui#index"
   get "swagger", to: "ui#swagger"
   get "scalar", to: "ui#scalar"
+  get "system.json", to: "ui#system_spec", defaults: { format: :json }, as: :system_spec
+  get "system/insights", to: "ui#system_insights", defaults: { format: :json }, as: :system_insights
+  get "system", to: "ui#system", as: :system
   get "spec", to: "ui#spec", defaults: { format: :json }
 end

data/lib/docit/ai/autodoc_runner.rb

@@ -62,11 +62,11 @@ module Docit
         end
 
         routes_file = Rails.root.join("config", "routes.rb")
-        if File.exist?(routes_file) && !File.read(routes_file).include?("Docit::Engine")
-          @output.puts "Warning: Docit engine is not mounted in config/routes.rb"
-          @output.puts "  Run: rails generate docit:install (or add: mount Docit::Engine => \"/api-docs\")"
-          @output.puts ""
-        end
+        return unless File.exist?(routes_file) && !File.read(routes_file).include?("Docit::Engine")
+
+        @output.puts "Warning: Docit engine is not mounted in config/routes.rb"
+        @output.puts "  Run: rails generate docit:install (or add: mount Docit::Engine => \"/api-docs\")"
+        @output.puts ""
       end
 
       def detect_gaps
@@ -84,20 +84,20 @@ module Docit
         @output.puts "Docit will send controller source code to #{config.provider.capitalize} to generate documentation."
         @output.puts "Review the endpoints first if they contain secrets or proprietary logic."
 
-        if @input.respond_to?(:tty?) && @input.tty?
-          loop do
-            @output.print "Continue? (y/n): "
-            choice = @input.gets.to_s.strip.downcase
-
-            case choice
-            when "y", "yes"
-              @output.puts ""
-              return
-            when "n", "no"
-              raise Docit::Error, "Autodoc cancelled."
-            else
-              @output.puts "Please enter y or n."
-            end
+        return unless @input.respond_to?(:tty?) && @input.tty?
+
+        loop do
+          @output.print "Continue? (y/n): "
+          choice = @input.gets.to_s.strip.downcase
+
+          case choice
+          when "y", "yes"
+            @output.puts ""
+            return
+          when "n", "no"
+            raise Docit::Error, "Autodoc cancelled."
+          else
+            @output.puts "Please enter y or n."
           end
         end
       end
@@ -138,6 +138,7 @@ module Docit
             invalid_output_retries += 1
             if invalid_output_retries <= MAX_INVALID_OUTPUT_RETRIES
               validation_error = e.message
+              @output.puts " invalid output, retrying"
               retry
             end
 
@@ -184,11 +185,11 @@ module Docit
 
       def inject_tags(generated)
         all_tags = generated.values.flatten.join("\n").scan(/tags\s+["']([^"']+)["']/).flatten
-        if all_tags.any?
-          injected = TagInjector.new(tags: all_tags).inject
-          injected.each { |tag| @output.puts "  Added tag \"#{tag}\" to config/initializers/docit.rb" }
-          @results[:tags] = injected
-        end
+        return unless all_tags.any?
+
+        injected = TagInjector.new(tags: all_tags).inject
+        injected.each { |tag| @output.puts "  Added tag \"#{tag}\" to config/initializers/docit.rb" }
+        @results[:tags] = injected
       end
 
       def strip_markdown_fences(text)

data/lib/docit/ai/system_insight_generator.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Docit
+  module Ai
+    class SystemInsightGenerator
+      # mode: :nodes  -> explain an arbitrary selection (diagram "AI Explain")
+      #       :section -> explain one resource and how its endpoints work together
+      def initialize(graph:, selected_node_ids: [], mode: :nodes)
+        @graph = graph
+        @selected_node_ids = selected_node_ids
+        @mode = mode
+      end
+
+      def generate
+        config = Configuration.load
+        Client.for(config).generate(prompt)
+      end
+
+      private
+
+      attr_reader :graph, :selected_node_ids, :mode
+
+      def prompt
+        mode == :section ? section_prompt : nodes_prompt
+      end
+
+      def nodes_prompt
+        <<~PROMPT
+          You are a senior engineer explaining a Rails system architecture to a developer. Keep your explanation extremely concise, professional, and clear. Avoid fluff, unnecessary details, or general tutorial information. Focus only on the provided components.
+
+          FORMAT YOUR RESPONSE EXACTLY LIKE THIS:
+
+          ## Overview
+          A 1-2 sentence plain-English summary of what this component/action does.
+
+          ## Data Flow
+          Show a simple, linear flow diagram using text and arrows (→). Keep it to 1 line if possible.
+          Example:
+            Client → GET /api/v1/users → UsersController#index → queries User model
+
+          ## Connections & Interactions
+          List only the direct, relevant relationships from the graph (max 3 bullets):
+          - **Component** (type): Action details/purpose.
+
+          Do not invent or assume anything outside of the provided graph. Keep the total response under 150 words.
+
+          ---
+
+          Selected node ids:
+          #{selected_node_ids.join("\n")}
+
+          Graph JSON:
+          #{JSON.pretty_generate(compact_graph)}
+        PROMPT
+      end
+
+      def section_prompt
+        <<~PROMPT
+          You are a senior engineer writing the introduction to a section of API documentation. The section covers ONE resource and all of its endpoints. Explain, for a developer new to this codebase, what the resource is for and how its endpoints work together as a workflow.
+
+          Use the documented summaries where available. Where an endpoint has no documentation, infer cautiously from its HTTP method and path, and do not fabricate behavior.
+
+          FORMAT YOUR RESPONSE EXACTLY LIKE THIS:
+
+          ## What this section does
+          1-2 sentences on the resource and its overall purpose.
+
+          ## How the endpoints work together
+          A short narrative (2-4 sentences) describing the typical flow across these endpoints — e.g. how a client lists, creates, then updates this resource. Reference endpoints by their HTTP method and path.
+
+          ## Notes
+          Up to 2 bullets on related models/services or anything a consumer must know. Omit this section if there is nothing concrete to say.
+
+          Do not invent endpoints, fields, or behavior not present in the graph. Keep the total response under 180 words.
+
+          ---
+
+          Endpoint node ids in this section:
+          #{selected_node_ids.join("\n")}
+
+          Graph JSON:
+          #{JSON.pretty_generate(compact_graph)}
+        PROMPT
+      end
+
+      def compact_graph
+        nodes = selected_nodes
+        node_ids = nodes.map { |node| node[:id] }
+
+        # Include edges where at least one end is in the selection
+        related_edges = graph[:edges].select do |edge|
+          node_ids.include?(edge[:source]) || node_ids.include?(edge[:target])
+        end
+
+        # Also include neighbor nodes (one hop away) for context
+        neighbor_ids = Set.new(node_ids)
+        related_edges.each do |edge|
+          neighbor_ids.add(edge[:source])
+          neighbor_ids.add(edge[:target])
+        end
+
+        neighbor_nodes = graph[:nodes].select { |node| neighbor_ids.include?(node[:id]) }
+
+        {
+          selected_nodes: nodes.map { |node| compact_hash(node, %i[id type label status file metadata]) },
+          context_nodes: (neighbor_nodes - nodes).map { |node| compact_hash(node, %i[id type label status]) },
+          edges: related_edges.map { |edge| compact_hash(edge, %i[source target type confidence evidence]) },
+          stats: graph[:stats]
+        }
+      end
+
+      def selected_nodes
+        return graph[:nodes] if selected_node_ids.empty?
+
+        graph[:nodes].select { |node| selected_node_ids.include?(node[:id]) }
+      end
+
+      def compact_hash(hash, keys)
+        keys.each_with_object({}) do |key, result|
+          result[key] = hash[key] if hash.key?(key)
+        end
+      end
+    end
+  end
+end

data/lib/docit/ai/tag_injector.rb

@@ -8,7 +8,7 @@ module Docit
       end
 
       def inject
-        return [] if initializer_path && File.exist?(initializer_path) == false
+        return [] unless initializer_path && File.exist?(initializer_path)
 
         content = File.read(initializer_path)
         existing_tags = content.scan(/config\.tag\s+["']([^"']+)["']/).flatten

data/lib/docit/ai.rb

@@ -12,3 +12,4 @@ require_relative "ai/doc_writer"
 require_relative "ai/tag_injector"
 require_relative "ai/autodoc_runner"
 require_relative "ai/scaffold_generator"
+require_relative "ai/system_insight_generator"

data/lib/docit/configuration.rb

@@ -5,7 +5,8 @@ module Docit
   class Configuration
     SUPPORTED_UIS = %i[scalar swagger].freeze
 
-    attr_accessor :title, :version, :description, :base_url
+    attr_accessor :title, :version, :description, :base_url,
+                  :system_graph_enabled, :system_graph_excluded_paths
     attr_reader :default_ui
 
     def initialize
@@ -13,10 +14,15 @@ module Docit
       @version = "1.0.0"
       @description = "Welcome to the API documentation. Browse the endpoints below to get started."
       @base_url = "/"
+      @system_graph_enabled = true
+      @system_graph_excluded_paths = []
       @default_ui = :scalar
       @security_schemes = {}
       @tags = []
       @servers = []
+      @license = nil
+      @contact = nil
+      @terms_of_service = nil
     end
 
     def default_ui=(value)
@@ -75,5 +81,35 @@ module Docit
     def servers
       @servers.dup
     end
+
+    def license(name:, url: nil)
+      entry = { name: name }
+      entry[:url] = url if url
+      @license = entry
+    end
+
+    def license_info
+      @license&.dup
+    end
+
+    def contact(name: nil, email: nil, url: nil)
+      entry = {}
+      entry[:name] = name if name
+      entry[:email] = email if email
+      entry[:url] = url if url
+      @contact = entry
+    end
+
+    def contact_info
+      @contact&.dup
+    end
+
+    def terms_of_service(url)
+      @terms_of_service = url
+    end
+
+    def terms_of_service_url
+      @terms_of_service
+    end
   end
 end

data/lib/docit/doc_file.rb

@@ -40,7 +40,7 @@ module Docit
       base.instance_variable_set(:@_docs, {})
     end
 
-    # The block receives the same DSL as swagger_doc.
+    # The block receives the same DSL as doc_for.
     def doc(action, &block)
       @_docs[action.to_sym] = block
     end