Contents

# frozen_string_literal: true

module Yori
  module Schema
    module V3
      # ExternalDocumentation: Allows referencing an external resource for extended documentation.
      # @description: A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.
      # @url: REQUIRED. The URL for the target documentation. Value MUST be in the format of a URL.
      class ExternalDocumentation < Yori::SchemaBase
        fields :description, :url

        def validate!
          validate_require_fields!('url')
        end
      end
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
yori-0.1.2	lib/yori/schema/v3/external_documentation.rb
yori-0.1.1	lib/yori/schema/v3/external_documentation.rb
yori-0.1.0	lib/yori/schema/v3/external_documentation.rb