Class: OpenActive::Models::WebAPI

Inherits:
JsonLdModel show all
Defined in:
lib/openactive/models/web_api.rb

Overview

## **EARLY RELEASE NOTICE** In order to expedite the OpenActive tooling work, this class has been added to the model for the purposes of testing. IT IS SUBJECT TO CHANGE, as the [Dataset API Discovery specification](www.openactive.io/dataset-api-discovery/EditorsDraft/) evolves.

This type is derived from [WebAPI](pending.schema.org/WebAPI), which means that any of this type’s properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.

Instance Attribute Summary collapse

Attributes inherited from JsonLdModel

#context, #id

Method Summary

Methods inherited from BaseModel

#assign_attributes, define_property, deserialize, #deserialize, deserialize_class, #initialize, #serialize, serialize, #set_property, #to_json

Methods included from Concerns::TypeChecker

#check_types, included

Methods included from Concerns::JsonLdSerializable

included, #to_h, #values

Constructor Details

This class inherits a constructor from OpenActive::BaseModel

Instance Attribute Details

#conforms_to ⇒ Array<URI>

Returns:

  • (Array<URI>) 


27
28
29
 
# File 'lib/openactive/models/web_api.rb', line 27

def conforms_to
  @conforms_to
end

#description ⇒ String

Returns:

  • (String) 


22
23
24
 
# File 'lib/openactive/models/web_api.rb', line 22

def description
  @description
end

#documentation ⇒ URI

Returns:

  • (URI) 


32
33
34
 
# File 'lib/openactive/models/web_api.rb', line 32

def documentation
  @documentation
end

#endpoint_description ⇒ URI

Returns:

  • (URI) 


37
38
39
 
# File 'lib/openactive/models/web_api.rb', line 37

def endpoint_description
  @endpoint_description
end

#endpoint_url ⇒ URI

Returns:

  • (URI) 


42
43
44
 
# File 'lib/openactive/models/web_api.rb', line 42

def endpoint_url
  @endpoint_url
end

#landing_page ⇒ URI

Returns:

  • (URI) 


47
48
49
 
# File 'lib/openactive/models/web_api.rb', line 47

def landing_page
  @landing_page
end

#name ⇒ String

Returns:

  • (String) 


17
18
19
 
# File 'lib/openactive/models/web_api.rb', line 17

def name
  @name
end

#terms_of_service ⇒ URI

Returns:

  • (URI) 


52
53
54
 
# File 'lib/openactive/models/web_api.rb', line 52

def terms_of_service
  @terms_of_service
end

#type ⇒ String

Returns:

  • (String) 


12
13
14
 
# File 'lib/openactive/models/web_api.rb', line 12

def type
  "WebAPI"
end