Module: SchemaOrg::Mixins::WebAPI

Includes:
Service
Included in:
WebAPI
Defined in:
lib/schema_org/mixins/web_api.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Service

#aggregate_rating, #aggregate_rating=, #area_served, #area_served=, #audience, #audience=, #available_channel, #available_channel=, #award, #award=, #brand, #brand=, #broker, #broker=, #category, #category=, #has_certification, #has_certification=, #has_offer_catalog, #has_offer_catalog=, #hours_available, #hours_available=, #is_related_to, #is_related_to=, #is_similar_to, #is_similar_to=, #logo, #logo=, #offers, #offers=, #produces, #produces=, #provider, #provider=, #provider_mobility, #provider_mobility=, #review, #review=, #service_area, #service_area=, #service_audience, #service_audience=, #service_output, #service_output=, #service_type, #service_type=, #slogan, #slogan=, #terms_of_service, #terms_of_service=

Methods included from Thing

#additional_type, #additional_type=, #alternate_name, #alternate_name=, #description, #description=, #disambiguating_description, #disambiguating_description=, #identifier, #identifier=, #image, #image=, #main_entity_of_page, #main_entity_of_page=, #name, #name=, #owner, #owner=, #potential_action, #potential_action=, #same_as, #same_as=, #subject_of, #subject_of=, #url, #url=

Class Method Details

.schema_property_definitions ⇒ Object 



11
12
13
14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/schema_org/mixins/web_api.rb', line 11

def self.schema_property_definitions
  {
    documentation: {
      schema_name: "documentation",
      schema_url: "https://schema.org/documentation",
      comment_lines: ["Further documentation describing the Web API in more detail."].freeze,
      ranges: ["CreativeWork", "URL"].freeze,
      external_ranges: [].freeze,
      inverse_of: nil,
      superseded_by: nil,
      supersedes: nil
    }.freeze
  }.freeze
end

Instance Method Details

#documentation ⇒ Object

Further documentation describing the Web API in more detail.



27
28
29
 
# File 'lib/schema_org/mixins/web_api.rb', line 27

def documentation
  read_property(:documentation)
end

#documentation=(value) ⇒ Object

Further documentation describing the Web API in more detail.



32
33
34
 
# File 'lib/schema_org/mixins/web_api.rb', line 32

def documentation=(value)
  write_property(:documentation, value)
end