RubyGems - inferno_core - Versions diffs - 0.0.6 → 0.0.8 - Mend

inferno_core 0.0.6 → 0.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (45) hide show

checksums.yaml +4 -4
data/bin/inferno +7 -0
data/lib/inferno/apps/cli/console.rb +12 -0
data/lib/inferno/apps/cli/main.rb +18 -0
data/lib/inferno/apps/cli/migration.rb +14 -0
data/lib/inferno/apps/cli.rb +8 -0
data/lib/inferno/apps/web/index.html.erb +1 -0
data/lib/inferno/config/application.rb +3 -0
data/lib/inferno/config/boot/db.rb +1 -9
data/lib/inferno/config/boot/logging.rb +2 -0
data/lib/inferno/db/migrations/001_create_initial_structure.rb +1 -1
data/lib/inferno/db/schema.rb +1 -1
data/lib/inferno/dsl/assertions.rb +66 -1
data/lib/inferno/dsl/configurable.rb +1 -1
data/lib/inferno/dsl/fhir_client.rb +22 -18
data/lib/inferno/dsl/fhir_client_builder.rb +3 -3
data/lib/inferno/dsl/fhir_validation.rb +105 -1
data/lib/inferno/dsl/http_client.rb +4 -4
data/lib/inferno/dsl/http_client_builder.rb +3 -3
data/lib/inferno/dsl/request_storage.rb +8 -8
data/lib/inferno/dsl/results.rb +1 -1
data/lib/inferno/dsl/resume_test_route.rb +9 -9
data/lib/inferno/dsl/runnable.rb +36 -18
data/lib/inferno/entities/header.rb +14 -7
data/lib/inferno/entities/message.rb +16 -8
data/lib/inferno/entities/request.rb +32 -19
data/lib/inferno/entities/result.rb +36 -29
data/lib/inferno/entities/session_data.rb +12 -6
data/lib/inferno/entities/test.rb +13 -0
data/lib/inferno/entities/test_run.rb +29 -6
data/lib/inferno/entities/test_session.rb +16 -10
data/lib/inferno/public/217.bundle.js +1 -1
data/lib/inferno/public/bundle.js +154 -1
data/lib/inferno/public/bundle.js.LICENSE.txt +15 -0
data/lib/inferno/repositories/in_memory_repository.rb +1 -1
data/lib/inferno/repositories/results.rb +1 -1
data/lib/inferno/spec_support.rb +1 -1
data/lib/inferno/test_runner.rb +1 -1
data/lib/inferno/utils/markdown_formatter.rb +1 -1
data/lib/inferno/utils/middleware/request_logger.rb +9 -3
data/lib/inferno/utils/migration.rb +17 -0
data/lib/inferno/version.rb +1 -1
data/lib/inferno.rb +0 -4
metadata +41 -8
data/bin/inferno-console +0 -8

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40769c54fd3854730eb080d1bb9e0755ff1551b00761968155d463dd3a6ce3e0
-  data.tar.gz: 8bbf5aaa2b09d7d5ff54e56a3ed33ce4e1f4df29fc53e3737f18e9972dc34f1e
+  metadata.gz: ef5b26a5633a33054fd378a523bc3a768e1a77ef572180db26ea792899cfc86a
+  data.tar.gz: b08e8c22c830ab2547d02e89d08e97bfc8248ce1fd8705d95b25d25df1925565
 SHA512:
-  metadata.gz: 35fe2518d3856f01b3358da68d862318784f05ab067b579d3ac62053dc1deed2be2895e3cfb5ff8efbc97e71d2495a11ebf66eadf23c5b8b4edb502707334838
-  data.tar.gz: 04e37af9daf40c01f0d4182f055e4ddf187d72f0e9d8a43e8858af5c549a4a60900d71f034a8e027e20f53a56f6b5e835bce1fca3a0b98870b07e0681793a2d9
+  metadata.gz: a22e65c16f1b80abec1c1e182a91ffa44cdb4e78cfad7ec6233c07cbcbfcdf221a5444aa7bec88c4a6bdb99ad95623926d88f6ed60b3888fa0b7bfc1b5a32793
+  data.tar.gz: d9717b4a08e8650071bb679ff964f85efd9d771a8f361a4b0a0781d7e9e91ea9ff764e6c8760a34f063e97944fedfb06b86349cd95cb29561844dc20a37401c1

data/bin/inferno ADDED Viewed

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require 'pry'
+require_relative '../lib/inferno/config/application'
+require_relative '../lib/inferno/apps/cli'
+Inferno::CLI::Main.start

data/lib/inferno/apps/cli/console.rb ADDED Viewed

@@ -0,0 +1,12 @@
+module Inferno
+  module CLI
+    class Console
+      def run
+        require_relative '../../../inferno'
+        Inferno::Application.finalize!
+        Pry.start
+      end
+    end
+  end
+end

data/lib/inferno/apps/cli/main.rb ADDED Viewed

@@ -0,0 +1,18 @@
+require_relative 'console'
+require_relative 'migration'
+module Inferno
+  module CLI
+    class Main < Thor
+      desc 'console', 'Start an interactive console session with Inferno'
+      def console
+        Console.new.run
+      end
+      desc 'migrate', 'Run database migrations'
+      def migrate
+        Migration.new.run
+      end
+    end
+  end
+end

data/lib/inferno/apps/cli/migration.rb ADDED Viewed

@@ -0,0 +1,14 @@
+require_relative '../../utils/migration'
+module Inferno
+  module CLI
+    class Migration
+      def run
+        Inferno::Application.start(:logging)
+        Inferno::Application['logger'].level = Logger::DEBUG
+        Utils::Migration.new.run
+      end
+    end
+  end
+end

data/lib/inferno/apps/cli.rb ADDED Viewed

@@ -0,0 +1,8 @@
+require 'thor'
+require_relative 'cli/main'
+module Inferno
+  module CLI
+  end
+end

data/lib/inferno/apps/web/index.html.erb CHANGED Viewed

@@ -1,6 +1,7 @@
 <!DOCTYPE html>
 <html lang="en">
   <head>
+    <base href="/">
     <meta charset="utf-8" />
     <link rel="icon" href="/public/favicon.ico" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />

data/lib/inferno/config/application.rb CHANGED Viewed

@@ -1,4 +1,7 @@
+require 'active_support/all'
+require 'dotenv'
 require 'dry/system/container'
+require 'sequel'
 require_relative 'boot'
 module Inferno

data/lib/inferno/config/boot/db.rb CHANGED Viewed

@@ -12,6 +12,7 @@ Inferno::Application.boot(:db) do
     config = YAML.load_file(config_path)[ENV['APP_ENV']]
       .merge(logger: Inferno::Application['logger'])
     connection = Sequel.connect(config)
+    connection.sql_log_level = :debug
     register('db.config', config)
     register('db.connection', connection)
@@ -19,14 +20,5 @@ Inferno::Application.boot(:db) do
   start do
     Sequel.extension :migration
-    db = Inferno::Application['db.connection']
-    migration_path = File.join(Inferno::Application.root, 'lib', 'inferno', 'db', 'migrations')
-    Sequel::Migrator.run(db, migration_path)
-    if ENV['APP_ENV'] == 'development'
-      schema_path = File.join(Inferno::Application.root, 'lib', 'inferno', 'db', 'schema.rb')
-      db.extension :schema_dumper
-      File.open(schema_path, 'w') { |f| f.print(db.dump_schema_migration) }
-    end
   end
 end

data/lib/inferno/config/boot/logging.rb CHANGED Viewed

@@ -11,6 +11,8 @@ Inferno::Application.boot(:logging) do
         Logger.new($stdout)
       end
+    logger.level = Logger::INFO
     register('logger', logger)
   end
 end

data/lib/inferno/db/migrations/001_create_initial_structure.rb CHANGED Viewed

@@ -116,7 +116,7 @@ Sequel.migration do
       # Requires requests to be a part of tests now.
       foreign_key :result_id, :results, index: true, type: String
       foreign_key :test_session_id, :test_sessions, index: true, type: String
-      add_index [:test_session_id, :name], concurrently: true
+      index [:test_session_id, :name], concurrently: true
       column :created_at, DateTime, null: false
       column :updated_at, DateTime, null: false

data/lib/inferno/db/schema.rb CHANGED Viewed

@@ -95,13 +95,13 @@ Sequel.migration do
       String :response_body, :text=>true
       foreign_key :result_id, :results, :type=>String, :size=>255
       foreign_key :test_session_id, :test_sessions, :type=>String, :size=>255
-      String :"[:test_session_id, :name]"
       DateTime :created_at, :null=>false
       DateTime :updated_at, :null=>false
       index [:id]
       index [:result_id]
       index [:test_session_id]
+      index [:test_session_id, :name]
     end
     create_table(:result_outputs, :ignore_index_errors=>true) do

data/lib/inferno/dsl/assertions.rb CHANGED Viewed

@@ -3,22 +3,43 @@ require_relative '../exceptions'
 module Inferno
   module DSL
     module Assertions
+      # Make an assertion
+      #
+      # @param test a value whose truthiness will determine whether the
+      #   assertion passes or fails
+      # @param message [String] failure message
       def assert(test, message = '')
         raise Exceptions::AssertionException, message unless test
       end
+      # @private
       def bad_response_status_message(expected, received)
         "Bad response status: expected #{Array.wrap(expected).join(', ')}, but received #{received}"
       end
+      # Check an response's status
+      #
+      # @param status [Integer, Array<Integer>] a single integer or an array of
+      #   integer status codes
+      # @param response [Hash]
       def assert_response_status(status, response: self.response)
         assert Array.wrap(status).include?(response[:status]), bad_response_status_message(status, response[:status])
       end
+      # @private
       def bad_resource_type_message(expected, received)
         "Bad resource type received: expected #{expected}, but received #{received}"
       end
+      # Check a FHIR resource's type
+      #
+      # @param resource_type [String, Symbol, Class]
+      # @param resource [FHIR::Model]
+      # @example
+      #   # The resource type can be a symbol, String, or FHIR::Model class
+      #   assert_resource_type(:capability_statement)
+      #   assert_resource_type('CapabilityStatement')
+      #   assert_resource_type(FHIR::CapabilityStatement)
       def assert_resource_type(resource_type, resource: self.resource)
         resource_type_name = normalize_resource_type(resource_type)
@@ -26,15 +47,48 @@ module Inferno
                bad_resource_type_message(resource_type_name, resource&.resourceType)
       end
+      # @private
       def invalid_resource_message(profile_url)
         "Resource does not conform to the profile: #{profile_url}"
       end
+      # Validate a FHIR resource
+      #
+      # @param resource [FHIR::Model]
+      # @param profile_url [String] url of the profile to validate against,
+      #   defaults to validating against the base FHIR resource
       def assert_valid_resource(resource: self.resource, profile_url: nil)
         assert resource_is_valid?(resource: resource, profile_url: profile_url),
                invalid_resource_message(profile_url)
       end
+      # Validate each entry of a Bundle
+      #
+      # @param bundle [FHIR::Bundle]
+      # @param resource_types
+      # [String,Symbol,FHIR::Model,Array<String,Symbol,FHIR::Model>,Hash] If a
+      #   string, symbol, or FHIR::Model is provided, only that resource type
+      #   will be validated. If an array of strings is provided, only those
+      #   resource types will be validated. If a hash is provided with resource
+      #   types as keys and profile urls (or nil) as values, only those resource
+      #   types will be validated against the provided profile url or the base
+      #   resource if nil.
+      # @example
+      #   # Only validate Patient bundle entries
+      #   assert_valid_bundle_entries(resource_types: 'Patient')
+      #
+      #   # Only valiadte Patient and Condition bundle entries
+      #   assert_valid_bundle_entries(resource_types: ['Patient', 'Condition'])
+      #
+      #   # Only validate Patient and Condition bundle entries. Validate Patient
+      #   # resources against the given profile, and Codition resources against the
+      #   # base FHIR Condition resource.
+      #   assert_valid_bundle_entries(
+      #     resource_types: {
+      #       'Patient': 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient',
+      #       'Condition': nil
+      #     }
+      #   )
       def assert_valid_bundle_entries(bundle: resource, resource_types: {})
         assert_resource_type('Bundle', resource: bundle)
@@ -56,6 +110,7 @@ module Inferno
         assert invalid_resources.empty?, invalid_bundle_entries_message(invalid_resources)
       end
+      # @private
       def invalid_bundle_entries_message(invalid_resources)
         identifier_strings =
           invalid_resources
@@ -64,6 +119,7 @@ module Inferno
         "The following bundle entries are invalid: #{identifier_strings}"
       end
+      # @private
       def normalize_resource_type(resource_type)
         if resource_type.is_a? Class
           resource_type.name.demodulize
@@ -72,6 +128,7 @@ module Inferno
         end
       end
+      # @private
       def normalize_types_to_check(resource_types)
         case resource_types
         when Hash
@@ -83,14 +140,22 @@ module Inferno
         end
       end
+      # Check for valid JSON
+      #
+      # @param maybe_json_string [String]
+      # @param message [String] extra failure message
       def assert_valid_json(maybe_json_string, message = '')
         assert JSON.parse(maybe_json_string)
       rescue JSON::ParserError
         assert false, "Invalid JSON. #{message}"
       end
+      # Check for a valid http/https uri
+      #
+      # @param uri [String]
+      # @param message [String] custom failure message
       def assert_valid_http_uri(uri, message = '')
-        error_message = message || "\"#{uri}\" is not a valid URI"
+        error_message = message.presence || "\"#{uri}\" is not a valid URI"
         assert uri =~ /\A#{URI::DEFAULT_PARSER.make_regexp(['http', 'https'])}\z/, error_message
       end

data/lib/inferno/dsl/configurable.rb CHANGED Viewed

@@ -15,7 +15,7 @@ module Inferno
         @config.apply(new_configuration)
       end
-      # @api private
+      # @private
       class Configuration
         attr_accessor :configuration

data/lib/inferno/dsl/fhir_client.rb CHANGED Viewed

@@ -35,7 +35,7 @@ module Inferno
     # @see Inferno::FHIRClientBuilder Documentation for the client
     #   configuration DSL
     module FHIRClient
-      # @api private
+      # @private
       def self.included(klass)
         klass.extend ClassMethods
         klass.extend Forwardable
@@ -54,7 +54,7 @@ module Inferno
           FHIRClientBuilder.new.build(self, self.class.fhir_client_definitions[client])
       end
-      # @api private
+      # @private
       def fhir_clients
         @fhir_clients ||= {}
       end
@@ -69,15 +69,15 @@ module Inferno
       # @param client [Symbol]
       # @param name [Symbol] Name for this request to allow it to be used by
       #   other tests
-      # @option options [Hash]  Input headers here - headers are optional and
-      #   must be entered as the last piece of input to this method
+      # @param headers [Hash] custom headers for this operation
       # @return [Inferno::Entities::Request]
-      def fhir_operation(path, body: nil, client: :default, name: nil, **options)
+      def fhir_operation(path, body: nil, client: :default, name: nil, headers: {})
         store_request('outgoing', name) do
-          headers = fhir_client(client).fhir_headers
-          headers.merge!('Content-Type' => 'application/fhir+json') if body.present?
-          headers.merge!(options[:headers]) if options[:headers].present?
-          fhir_client(client).send(:post, path, body, headers)
+          operation_headers = fhir_client(client).fhir_headers
+          operation_headers.merge!('Content-Type' => 'application/fhir+json') if body.present?
+          operation_headers.merge!(headers) if headers.present?
+          fhir_client(client).send(:post, path, body, operation_headers)
         end
       end
@@ -86,9 +86,8 @@ module Inferno
       # @param client [Symbol]
       # @param name [Symbol] Name for this request to allow it to be used by
       #   other tests
-      # @param _options [Hash] TODO
       # @return [Inferno::Entities::Request]
-      def fhir_get_capability_statement(client: :default, name: nil, **_options)
+      def fhir_get_capability_statement(client: :default, name: nil)
         store_request('outgoing', name) do
           fhir_client(client).conformance_statement
           fhir_client(client).reply
@@ -102,9 +101,8 @@ module Inferno
       # @param client [Symbol]
       # @param name [Symbol] Name for this request to allow it to be used by
       #   other tests
-      # @param _options [Hash] TODO
       # @return [Inferno::Entities::Request]
-      def fhir_read(resource_type, id, client: :default, name: nil, **_options)
+      def fhir_read(resource_type, id, client: :default, name: nil)
         store_request('outgoing', name) do
           fhir_client(client).read(fhir_class_from_resource_type(resource_type), id)
         end
@@ -117,24 +115,30 @@ module Inferno
       # @param params [Hash] the search params
       # @param name [Symbol] Name for this request to allow it to be used by
       #   other tests
-      # @param _options [Hash] TODO
+      # @param search_method [Symbol] Use `:post` to search via POST
       # @return [Inferno::Entities::Request]
-      def fhir_search(resource_type, client: :default, params: {}, name: nil, **_options)
+      def fhir_search(resource_type, client: :default, params: {}, name: nil, search_method: :get)
+        search =
+          if search_method == :post
+            { body: params }
+          else
+            { parameters: params }
+          end
         store_request('outgoing', name) do
           fhir_client(client)
-            .search(fhir_class_from_resource_type(resource_type), search: { parameters: params })
+            .search(fhir_class_from_resource_type(resource_type), { search: search })
         end
       end
       # @todo Make this a FHIR class method? Something like
       #   FHIR.class_for(resource_type)
-      # @api private
+      # @private
       def fhir_class_from_resource_type(resource_type)
         FHIR.const_get(resource_type.to_s.camelize)
       end
       module ClassMethods
-        # @api private
+        # @private
         def fhir_client_definitions
           @fhir_client_definitions ||= {}
         end

data/lib/inferno/dsl/fhir_client_builder.rb CHANGED Viewed

@@ -6,7 +6,7 @@ module Inferno
     class FHIRClientBuilder
       attr_accessor :runnable
-      # @api private
+      # @private
       def build(runnable, block)
         self.runnable = runnable
         instance_exec(self, &block)
@@ -56,14 +56,14 @@ module Inferno
         @headers ||= headers
       end
-      # @api private
+      # @private
       def method_missing(name, *args, &block)
         return runnable.call(name, *args, &block) if runnable.respond_to? name
         super
       end
-      # @api private
+      # @private
       def respond_to_missing?(name)
         runnable.respond_to?(name) || super
       end

data/lib/inferno/dsl/fhir_validation.rb CHANGED Viewed

@@ -1,38 +1,113 @@
 module Inferno
   module DSL
+    # This module contains the methods needed to configure a validator to
+    # perform validation of FHIR resources. The actual validation is performed
+    # by an external FHIR validation service. Tests will typically rely on
+    # `assert_valid_resource` for validation rather than directly calling
+    # methods on a validator.
+    #
+    # @example
+    #
+    #   validator do
+    #     url 'http://example.com/validator'
+    #     exclude_message { |message| message.type == 'info' }
+    #     perform_additional_validation do |resource, profile_url|
+    #       if something_is_wrong
+    #         { type: 'error', message: 'something is wrong' }
+    #       else
+    #         { type: 'info', message: 'everything is ok' }
+    #       end
+    #     end
+    #   end
     module FHIRValidation
       def self.included(klass)
         klass.extend ClassMethods
       end
+      # Perform validation, and add validation messages to the runnable
+      #
+      # @param resource [FHIR::Model]
+      # @param profile_url [String]
+      # @param validator [Symbol] the name of the validator to use
+      # @return [Boolean] whether the resource is valid
       def resource_is_valid?(resource: self.resource, profile_url: nil, validator: :default)
         find_validator(validator).resource_is_valid?(resource, profile_url, self)
       end
+      # Find a particular validator. Looks through a runnable's parents up to
+      # the suite to find a validator with a particular name
       def find_validator(validator_name)
         self.class.find_validator(validator_name)
       end
       class Validator
+        # @private
         def initialize(&block)
           instance_eval(&block)
         end
+        # @private
         def default_validator_url
           ENV.fetch('VALIDATOR_URL')
         end
+        # Set the url of the validator service
+        #
+        # @param url [String]
         def url(validator_url = nil)
           @url = validator_url if validator_url
           @url
         end
+        # @private
+        def additional_validations
+          @additional_validations ||= []
+        end
+        # Perform validation steps in addition to FHIR validation.
+        #
+        # @example
+        #   perform_additional_validation do |resource, profile_url|
+        #     if something_is_wrong
+        #       { type: 'error', message: 'something is wrong' }
+        #     else
+        #       { type: 'info', message: 'everything is ok' }
+        #     end
+        #   end
+        # @yieldparam resource [FHIR::Model] the resource being validated
+        # @yieldparam profile_url [String] the profile the resource is being
+        #   validated against
+        # @yieldreturn [Array<Hash<Symbol, String>>,Hash<Symbol, String>] The
+        #   block should return a Hash or an Array of Hashes if any validation
+        #   messages should be added. The Hash must contain two keys: `:type`
+        #   and `:message`. `:type` can have a value of `'info'`, `'warning'`,
+        #   or `'error'`. A type of `'error'` means the resource is invalid.
+        #   `:message` contains the message string itself.
+        def perform_additional_validation(&block)
+          additional_validations << block
+        end
+        # @private
+        def additional_validation_messages(resource, profile_url)
+          additional_validations
+            .flat_map { |step| step.call(resource, profile_url) }
+            .select { |message| message.is_a? Hash }
+        end
+        # Filter out unwanted validation messages
+        #
+        # @example
+        #   validator do
+        #     exclude_message { |message| message.type == 'info' }
+        #   end
+        # @yieldparam message [Inferno::Entities::Message]
         def exclude_message(&block)
           @exclude_message = block if block_given?
           @exclude_message
         end
+        # @see Inferno::DSL::FHIRValidation#resource_is_valid?
         def resource_is_valid?(resource, profile_url, runnable)
           profile_url ||= FHIR::Definitions.resource_definition(resource.resourceType).url
@@ -40,6 +115,8 @@ module Inferno
           message_hashes = outcome.issue&.map { |issue| message_hash_from_issue(issue) } || []
+          message_hashes.concat(additional_validation_messages(resource, profile_url))
           filter_messages(message_hashes)
           message_hashes
@@ -47,10 +124,12 @@ module Inferno
             .none? { |message_hash| message_hash[:type] == 'error' }
         end
+        # @private
         def filter_messages(message_hashes)
           message_hashes.reject! { |message| exclude_message.call(Entities::Message.new(message)) } if exclude_message
         end
+        # @private
         def message_hash_from_issue(issue)
           {
             type: issue_severity(issue),
@@ -58,6 +137,7 @@ module Inferno
           }
         end
+        # @private
         def issue_severity(issue)
           case issue.severity
           when 'warning'
@@ -69,6 +149,7 @@ module Inferno
           end
         end
+        # @private
         def issue_message(issue)
           location = if issue.respond_to?(:expression)
                        issue.expression&.join(', ')
@@ -79,6 +160,11 @@ module Inferno
           "#{location}: #{issue&.details&.text}"
         end
+        # Post a resource to the validation service for validating.
+        #
+        # @param resource [FHIR::Model]
+        # @param profile_url [String]
+        # @return [String] the body of the validation response
         def validate(resource, profile_url)
           RestClient.post(
             "#{url}/validate",
@@ -89,15 +175,33 @@ module Inferno
       end
       module ClassMethods
-        # @api private
+        # @private
         def fhir_validators
           @fhir_validators ||= {}
         end
+        # Define a validator
+        # @example
+        #   validator do
+        #     url 'http://example.com/validator'
+        #     exclude_message { |message| message.type == 'info' }
+        #     perform_additional_validation do |resource, profile_url|
+        #       if something_is_wrong
+        #         { type: 'error', message: 'something is wrong' }
+        #       else
+        #         { type: 'info', message: 'everything is ok' }
+        #       end
+        #     end
+        #   end
+        #
+        # @param name [Symbol] the name of the validator, only needed if you are
+        #   using multiple validators
         def validator(name = :default, &block)
           fhir_validators[name] = Inferno::DSL::FHIRValidation::Validator.new(&block)
         end
+        # Find a particular validator. Looks through a runnable's parents up to
+        # the suite to find a validator with a particular name
         def find_validator(validator_name)
           validator = fhir_validators[validator_name] || parent&.find_validator(validator_name)

data/lib/inferno/dsl/http_client.rb CHANGED Viewed

@@ -16,7 +16,7 @@ module Inferno
     #         # performs a GET to https://example.com
     #         get
     #         # performs a GET to https://example.com/abc
-    #          get('abc')
+    #         get('abc')
     #
     #         request  # the most recent request
     #         response # the most recent response
@@ -27,7 +27,7 @@ module Inferno
     # @see Inferno::FHIRClientBuilder Documentation for the client
     #   configuration DSL
     module HTTPClient
-      # @api private
+      # @private
       def self.included(klass)
         klass.extend ClassMethods
         klass.include RequestStorage
@@ -47,7 +47,7 @@ module Inferno
         http_clients[client] = HTTPClientBuilder.new.build(self, definition)
       end
-      # @api private
+      # @private
       def http_clients
         @http_clients ||= {}
       end
@@ -104,7 +104,7 @@ module Inferno
       end
       module ClassMethods
-        # @api private
+        # @private
         def http_client_definitions
           @http_client_definitions ||= {}
         end