Skip to content

Commit e995ea1

Browse files
cncfcloudeventscncfcloudevents
committed
Generated docs for cloud_events 0.8.1
Signed-off-by: CNCF CloudEvents Bot <[email protected]>
1 parent d610a04 commit e995ea1

34 files changed

+14973
-1
lines changed

‎404.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
</p>
1010
</body>
1111
<script>
12-
var version = "0.8.0";
12+
var version = "0.8.1";
1313
var location_updated = false;
1414
if (!location_updated && window.location.href.includes("//cloudevents.github.io/sdk-ruby/latest")) {
1515
var loc = window.location.href.replace(

‎v0.8.1/CloudEvents.html‎

Lines changed: 283 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,283 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6+
<title>
7+
Module: CloudEvents
8+
9+
&mdash; CloudEvents
10+
11+
</title>
12+
13+
<link rel="stylesheet" href="css/style.css" type="text/css" />
14+
15+
<link rel="stylesheet" href="css/common.css" type="text/css" />
16+
17+
<script type="text/javascript">
18+
pathId = "CloudEvents";
19+
relpath = '';
20+
</script>
21+
22+
23+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24+
25+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26+
27+
28+
</head>
29+
<body>
30+
<div class="nav_wrap">
31+
<iframe id="nav" src="class_list.html?1"></iframe>
32+
<div id="resizer"></div>
33+
</div>
34+
35+
<div id="main" tabindex="-1">
36+
<div id="header">
37+
<div id="menu">
38+
39+
<a href="_index.html">Index (C)</a> &raquo;
40+
41+
42+
<span class="title">CloudEvents</span>
43+
44+
</div>
45+
46+
<div id="search">
47+
48+
<a class="full_list_link" id="class_list_link"
49+
href="class_list.html">
50+
51+
<svg width="24" height="24">
52+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55+
</svg>
56+
</a>
57+
58+
</div>
59+
<div class="clear"></div>
60+
</div>
61+
62+
<div id="content"><h1>Module: CloudEvents
63+
64+
65+
66+
</h1>
67+
<div class="box_info">
68+
69+
70+
71+
72+
73+
74+
75+
76+
77+
78+
79+
<dl>
80+
<dt>Defined in:</dt>
81+
<dd>lib/cloud_events.rb<span class="defines">,<br />
82+
lib/cloud_events/event.rb,<br /> lib/cloud_events/errors.rb,<br /> lib/cloud_events/format.rb,<br /> lib/cloud_events/version.rb,<br /> lib/cloud_events/event/v0.rb,<br /> lib/cloud_events/event/v1.rb,<br /> lib/cloud_events/event/utils.rb,<br /> lib/cloud_events/json_format.rb,<br /> lib/cloud_events/text_format.rb,<br /> lib/cloud_events/content_type.rb,<br /> lib/cloud_events/event/opaque.rb,<br /> lib/cloud_events/http_binding.rb,<br /> lib/cloud_events/event/field_interpreter.rb</span>
83+
</dd>
84+
</dl>
85+
86+
</div>
87+
88+
<h2>Overview</h2><div class="docstring">
89+
<div class="discussion">
90+
<p>CloudEvents implementation.</p>
91+
92+
<p>This is a Ruby implementation of the <a href="https://cloudevents.io">CloudEvents</a>
93+
specification. It supports both
94+
<a href="https://github.com/cloudevents/spec/blob/v0.3/spec.md">CloudEvents 0.3</a> and
95+
<a href="https://github.com/cloudevents/spec/blob/v1.0/spec.md">CloudEvents 1.0</a>.</p>
96+
97+
98+
</div>
99+
</div>
100+
<div class="tags">
101+
102+
103+
</div><h2>Defined Under Namespace</h2>
104+
<p class="children">
105+
106+
107+
<strong class="modules">Modules:</strong> <span class='object_link'><a href="CloudEvents/Event.html" title="CloudEvents::Event (module)">Event</a></span>, <span class='object_link'><a href="CloudEvents/Format.html" title="CloudEvents::Format (module)">Format</a></span>
108+
109+
110+
111+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="CloudEvents/AttributeError.html" title="CloudEvents::AttributeError (class)">AttributeError</a></span>, <span class='object_link'><a href="CloudEvents/CloudEventsError.html" title="CloudEvents::CloudEventsError (class)">CloudEventsError</a></span>, <span class='object_link'><a href="CloudEvents/ContentType.html" title="CloudEvents::ContentType (class)">ContentType</a></span>, <span class='object_link'><a href="CloudEvents/FormatSyntaxError.html" title="CloudEvents::FormatSyntaxError (class)">FormatSyntaxError</a></span>, <span class='object_link'><a href="CloudEvents/HttpBinding.html" title="CloudEvents::HttpBinding (class)">HttpBinding</a></span>, <span class='object_link'><a href="CloudEvents/JsonFormat.html" title="CloudEvents::JsonFormat (class)">JsonFormat</a></span>, <span class='object_link'><a href="CloudEvents/NotCloudEventError.html" title="CloudEvents::NotCloudEventError (class)">NotCloudEventError</a></span>, <span class='object_link'><a href="CloudEvents/SpecVersionError.html" title="CloudEvents::SpecVersionError (class)">SpecVersionError</a></span>, <span class='object_link'><a href="CloudEvents/TextFormat.html" title="CloudEvents::TextFormat (class)">TextFormat</a></span>, <span class='object_link'><a href="CloudEvents/UnsupportedFormatError.html" title="CloudEvents::UnsupportedFormatError (class)">UnsupportedFormatError</a></span>
112+
113+
114+
</p>
115+
116+
117+
<h2>
118+
Constant Summary
119+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
120+
</h2>
121+
122+
<dl class="constants">
123+
124+
<dt id="HttpContentError-constant" class="deprecated">HttpContentError =
125+
<div class="docstring">
126+
<div class="discussion">
127+
<div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'><p>Will be removed in version 1.0. Use <span class='object_link'><a href="CloudEvents/UnsupportedFormatError.html" title="CloudEvents::UnsupportedFormatError (class)">UnsupportedFormatError</a></span>.</p>
128+
</div></div>
129+
<p>Alias of UnsupportedFormatError, for backward compatibility.</p>
130+
131+
132+
</div>
133+
</div>
134+
<div class="tags">
135+
136+
137+
</div>
138+
</dt>
139+
<dd><pre class="code"><span class='const'><span class='object_link'><a href="CloudEvents/UnsupportedFormatError.html" title="CloudEvents::UnsupportedFormatError (class)">UnsupportedFormatError</a></span></span></pre></dd>
140+
141+
<dt id="VERSION-constant" class="">VERSION =
142+
<div class="docstring">
143+
<div class="discussion">
144+
<p>Version of the Ruby CloudEvents SDK</p>
145+
146+
147+
</div>
148+
</div>
149+
<div class="tags">
150+
151+
<p class="tag_title">Returns:</p>
152+
<ul class="return">
153+
154+
<li>
155+
156+
157+
<span class='type'>(<tt>String</tt>)</span>
158+
159+
160+
161+
</li>
162+
163+
</ul>
164+
165+
</div>
166+
</dt>
167+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.8.1</span><span class='tstring_end'>&quot;</span></span></pre></dd>
168+
169+
</dl>
170+
171+
172+
173+
174+
175+
176+
177+
178+
179+
<h2>
180+
Class Method Summary
181+
<small><a href="#" class="summary_toggle">collapse</a></small>
182+
</h2>
183+
184+
<ul class="summary">
185+
186+
<li class="public ">
187+
<span class="summary_signature">
188+
189+
<a href="#supported_spec_versions-class_method" title="supported_spec_versions (class method)">.<strong>supported_spec_versions</strong> &#x21d2; Array&lt;String&gt; </a>
190+
191+
192+
193+
</span>
194+
195+
196+
197+
198+
199+
200+
201+
202+
203+
<span class="summary_desc"><div class='inline'><p>The spec versions supported by this implementation.</p>
204+
</div></span>
205+
206+
</li>
207+
208+
209+
</ul>
210+
211+
212+
213+
214+
<div id="class_method_details" class="method_details_list">
215+
<h2>Class Method Details</h2>
216+
217+
218+
<div class="method_details first">
219+
<h3 class="signature first" id="supported_spec_versions-class_method">
220+
221+
.<strong>supported_spec_versions</strong> &#x21d2; <tt>Array&lt;String&gt;</tt>
222+
223+
224+
225+
226+
227+
</h3><div class="docstring">
228+
<div class="discussion">
229+
<p>The spec versions supported by this implementation.</p>
230+
231+
232+
</div>
233+
</div>
234+
<div class="tags">
235+
236+
<p class="tag_title">Returns:</p>
237+
<ul class="return">
238+
239+
<li>
240+
241+
242+
<span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
243+
244+
245+
246+
</li>
247+
248+
</ul>
249+
250+
</div><table class="source_code">
251+
<tr>
252+
<td>
253+
<pre class="lines">
254+
255+
256+
29
257+
30
258+
31</pre>
259+
</td>
260+
<td>
261+
<pre class="code"><span class="info file"># File 'lib/cloud_events.rb', line 29</span>
262+
263+
<span class='kw'>def</span> <span class='id identifier rubyid_supported_spec_versions'>supported_spec_versions</span>
264+
<span class='const'>SUPPORTED_SPEC_VERSIONS</span>
265+
<span class='kw'>end</span></pre>
266+
</td>
267+
</tr>
268+
</table>
269+
</div>
270+
271+
</div>
272+
273+
</div>
274+
275+
<div id="footer">
276+
Generated on Mon Nov 10 08:05:02 2025 by
277+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
278+
0.9.37 (ruby-3.4.7).
279+
</div>
280+
281+
</div>
282+
</body>
283+
</html>

0 commit comments

Comments
 (0)