Class: Ecfr::AdminService::EditorialNote
- Defined in:
- lib/ecfr/admin_service/editorial_note.rb,
lib/ecfr/admin_service/editorial_note/hierarchy.rb
Defined Under Namespace
Classes: Hierarchy
Constant Summary collapse
- EDITORIAL_NOTES_PATH =
"v1/editorial-notes"
Constants inherited from Base
Base::SUPPORTED_ARRAY_ACCESSORS
Instance Attribute Summary collapse
-
#editorial_note ⇒ String
readonly
content of the editorial note.
-
#end_date ⇒ Date
readonly
last date the editorial note applies to.
-
#hierarchies ⇒ [Hierarchy]
readonly
the hierarchies of the content this editorial note applies to.
-
#start_date ⇒ Date
readonly
first date the editorial note applies to.
Attributes inherited from Base
#metadata, #request_data, #response_status, #results
Class Method Summary collapse
-
.where(args) ⇒ [<EditorialNote>]
Retrieve a list of editorial notes.
Methods inherited from Base
base_url, service_name, service_path
Methods inherited from Base
basic_auth_client_options, #each, #initialize, metadata, metadata_key, result_key
Methods included from Extensible
Methods included from Ecfr::AttributeMethodDefinition
Methods inherited from Client
build, cache_key, client, client_pool, delete, execute, get, handle_response, perform, post, purge
Methods included from ParallelClient
Constructor Details
This class inherits a constructor from Ecfr::Base
Instance Attribute Details
#editorial_note ⇒ String (readonly)
content of the editorial note
8 9 |
# File 'lib/ecfr/admin_service/editorial_note.rb', line 8 attribute :editorial_note, desc: "content of the editorial note" |
#end_date ⇒ Date (readonly)
last date the editorial note applies to
11 12 13 |
# File 'lib/ecfr/admin_service/editorial_note.rb', line 11 attribute :end_date, type: :date, desc: "last date the editorial note applies to" |
#hierarchies ⇒ [Hierarchy] (readonly)
the hierarchies of the content this editorial note applies to
18 19 20 |
# File 'lib/ecfr/admin_service/editorial_note.rb', line 18 attribute :hierarchies, type: Array(Hierarchy), desc: "the hierarchies of the content this editorial note applies to" |
#start_date ⇒ Date (readonly)
first date the editorial note applies to
14 15 16 |
# File 'lib/ecfr/admin_service/editorial_note.rb', line 14 attribute :start_date, type: :date, desc: "first date the editorial note applies to" |
Class Method Details
.where(args) ⇒ [<EditorialNote>]
Retrieve a list of editorial notes
32 33 34 35 36 37 |
# File 'lib/ecfr/admin_service/editorial_note.rb', line 32 def self.where(args) perform( :get, "#{EDITORIAL_NOTES_PATH}/title-#{args[:title]}.json" ) end |