Skip to content

Commit 54687a2

Browse files
committed
checking in updated generated documentation
1 parent e77cec9 commit 54687a2

File tree

13 files changed

+88
-45
lines changed

13 files changed

+88
-45
lines changed

new_docs/build/breaking-changes.html

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
<html><head><title>Nest - Breaking changes</title><meta http-equiv="cache-control" content="no-cache"/><meta http-equiv="pragma" content="no-cache"/><meta http-equiv="content-type" content="text/html;charset=utf-8"/><meta http-equiv="expires" content="0"/><meta name="description" content="elasticsearch"/><meta name="keywords" content="nest, elasticsearch, .net, client"/><meta name="author" content="martijn laarman"/><meta name="viewport" content="width=device-width, initial-scale=1"/>
2-
<script src="/scripts/html5shiv.js"></script><link rel="stylesheet" type="text/css" href="/styles/normalize.css"/><link rel="stylesheet" type="text/css" href="/styles/layout.css"/><link rel="stylesheet" type="text/css" href="/styles/pygments.css"/><link rel="stylesheet" type="text/css" href="/styles/pygments.css"/><link rel="stylesheet" type="text/css" href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css"/><link href="//fonts.googleapis.com/css?family=Ubuntu+Mono|Open+Sans" rel="stylesheet" type="text/css"/><link href="/prettify/prettify.css" type="text/css" rel="stylesheet"/><link href="/prettify/sunburst.css" type="text/css" rel="stylesheet"/><script src="//code.jquery.com/jquery.min.js" type="text/javascript"></script><script type="text/javascript" src="/prettify/prettify.js"></script><script type="text/javascript" src="/prettify/fix_code_tags.js"></script></head><body><div class="wrapper"><header class="header"><div class="actions"><iframe src="//ghbtns.com/github-btn.html?user=elasticsearch&amp;repo=elasticsearch-net&amp;type=fork&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="95" height="20"></iframe><iframe src="//ghbtns.com/github-btn.html?user=elasticsearch&amp;repo=elasticsearch-net&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe></div><img src="/images/elasticsearch-net-nuget-icon.png" width="48" height="48"/><h1>Elasticsearch.Net & NEST</h1><p>Documentation</p></header><div class="divide"></div><div class="middle"><div class="container"><main class="content"><h1 id="breaking-changes">Breaking changes</h1>
1+
<html><head><title>Nest - Breaking Changes</title><meta http-equiv="cache-control" content="no-cache"/><meta http-equiv="pragma" content="no-cache"/><meta http-equiv="content-type" content="text/html;charset=utf-8"/><meta http-equiv="expires" content="0"/><meta name="description" content="elasticsearch"/><meta name="keywords" content="nest, elasticsearch, .net, client"/><meta name="author" content="martijn laarman"/><meta name="viewport" content="width=device-width, initial-scale=1"/>
2+
<script src="/scripts/html5shiv.js"></script><link rel="stylesheet" type="text/css" href="/styles/normalize.css"/><link rel="stylesheet" type="text/css" href="/styles/layout.css"/><link rel="stylesheet" type="text/css" href="/styles/pygments.css"/><link rel="stylesheet" type="text/css" href="/styles/pygments.css"/><link rel="stylesheet" type="text/css" href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css"/><link href="//fonts.googleapis.com/css?family=Ubuntu+Mono|Open+Sans" rel="stylesheet" type="text/css"/><link href="/prettify/prettify.css" type="text/css" rel="stylesheet"/><link href="/prettify/sunburst.css" type="text/css" rel="stylesheet"/><script src="//code.jquery.com/jquery.min.js" type="text/javascript"></script><script type="text/javascript" src="/prettify/prettify.js"></script><script type="text/javascript" src="/prettify/fix_code_tags.js"></script></head><body><div class="wrapper"><header class="header"><div class="actions"><iframe src="//ghbtns.com/github-btn.html?user=elasticsearch&amp;repo=elasticsearch-net&amp;type=fork&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="95" height="20"></iframe><iframe src="//ghbtns.com/github-btn.html?user=elasticsearch&amp;repo=elasticsearch-net&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe></div><img src="/images/elasticsearch-net-nuget-icon.png" width="48" height="48"/><h1>Elasticsearch.Net & NEST</h1><p>Documentation</p></header><div class="divide"></div><div class="middle"><div class="container"><main class="content"><h1 id="breaking-changes">Breaking Changes</h1>
33
<h2 id="elasticsearch-1-0">Elasticsearch 1.0</h2>
44
<p>Elasticsearch 1.0 comes with it&#39;s own set of breaking changes which <a href="http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/breaking-changes.html">are all documented in the elasticsearch documentation</a>. This page describes breaking changes NEST introduces in its 1.0 release and to an extend how you should handle Elasticsearch 1.0 changes in your exisiting code base using NEST prior to NEST 1.0.</p>
55
<h2 id="nest-1-0">NEST 1.0</h2>
6-
<h3 id="strong-named-packages">Strong named packages</h3>
6+
<h3 id="strong-named-packages">Strong Named Packages</h3>
77
<p>Prior to 1.0 NEST came with a <code>NEST</code> and <code>NEST.Signed</code> nuget package. In 1.0 there is one package called <code>NEST</code> which is a signed strong named assembly. We follow the example of JSON.NET and only change our <code>AssemblyVersion</code> on major releases only update the <code>AssemblyFileVersion</code> for every release. This way you get most of the benefits of unsigned assemblies while still providing support for developers who&#39;s business guidelines mandates the usage of signed assemblies.</p>
88
<h3 id="ielasticclient">IElasticClient</h3>
99
<p>The outer layer of NEST has been completely rewritten from scratch. Many calls will now have a different signature. Although the most common ones have been reimplemented as <a href="http://github.com/elasticsearch/elasticsearch-net/tree/master/src/Nest/ConvenienceExtensions">extensions methods</a>. Two notable changes should be outlined though. </p>
@@ -12,7 +12,26 @@ <h4 id="get-is-now-called-source-">Get() is now called Source()</h4>
1212
Similarily <code>GetMany()</code> is now called <code>SourceMany()</code>.</p>
1313
<h3 id="renamed-queryresponse-to-searchresponse">Renamed QueryResponse to SearchResponse</h3>
1414
<p>The fact that <code>client.Search&lt;T&gt;()</code> returns a <code>QueryResponse&lt;T&gt;</code> and not a <code>SearchResponse&lt;T&gt;</code> never felt right to me, NEST 1.0 therefor renamed <code>QueryResponse&lt;T&gt;</code> to <code>SearchResponse&lt;T&gt;</code></p>
15-
<h4 id="alias-helpers">Alias helpers</h4>
15+
<h3 id="renamed-rootobjectmappingdescriptor">Renamed RootObjectMappingDescriptor</h3>
16+
<p>to <code>PutMappingDescriptor&lt;T&gt;</code></p>
17+
<h3 id="removed-iresponse-error">Removed IResponse.Error</h3>
18+
<p>IResponse.Error.Exception no longer exists, it is inlined to IResponse.OriginalException. The Error property did not hold any information that was not available on IResponse.ConnectionStatus.</p>
19+
<h3 id="response-shortcuts">Response Shortcuts</h3>
20+
<p>Prior to 1.0 some calls directly returned a bool or value instead of the full envelopped Elasticsearch response.</p>
21+
<p>i.e <code>client.IndexExists(&quot;myIndexName&quot;)</code> used to return a bool but should now be called like this:</p>
22+
<pre><code> client.IndexExists(i =&gt; i.Index(&quot;myIndexName&quot;)).Exists
23+
</code></pre><h3 id="removed-mapfromattributes-">Removed MapFromAttributes()</h3>
24+
<p>Attributes are to limited in what they can specify so <code>[ElasticType()]</code> can now only specify the type name and the id property.
25+
All the other anotations have been removed from <code>[ElasticType()]</code>. The properties on <code>[ElasticProperty()]</code> still exists an can be applied like this:</p>
26+
<pre><code>var x = this._client.CreateIndex(index, s =&gt; s
27+
.AddMapping&lt;ElasticsearchProject&gt;(m =&gt; m
28+
.MapFromAttributes()
29+
.DateDetection()
30+
.IndexAnalyzer())
31+
);
32+
</code></pre><p>Or in a separate put mapping call:</p>
33+
<pre><code>var response = this._client.Map&lt;ElasticsearchProject&gt;(m=&gt;m.MapFromAttributes()......);
34+
</code></pre><h4 id="alias-helpers">Alias Helpers</h4>
1635
<p>NEST 0.12.0 had some alias helpers, <code>SwapAlias()</code>, <code>GetIndicesPointingToAlias()</code> these have been removed in favor of just <code>Alias()</code> and <code>GetAliases()</code>. Especially the later could benefit from some extension methods that make the common use cases a bit easier to program with. These did not make the beta release.</p>
1736
<h4 id="fields-vs-sourceinclude-">Fields() vs SourceInclude()</h4>
1837
<p>Prior to Elasticsearch you could specify to return only certain fields and they would return like this:</p>

new_docs/build/elasticsearch-net/building-requests.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<html><head><title>Nest - Building Requests</title><meta http-equiv="cache-control" content="no-cache"/><meta http-equiv="pragma" content="no-cache"/><meta http-equiv="content-type" content="text/html;charset=utf-8"/><meta http-equiv="expires" content="0"/><meta name="description" content="elasticsearch"/><meta name="keywords" content="nest, elasticsearch, .net, client"/><meta name="author" content="martijn laarman"/><meta name="viewport" content="width=device-width, initial-scale=1"/>
22
<script src="/scripts/html5shiv.js"></script><link rel="stylesheet" type="text/css" href="/styles/normalize.css"/><link rel="stylesheet" type="text/css" href="/styles/layout.css"/><link rel="stylesheet" type="text/css" href="/styles/pygments.css"/><link rel="stylesheet" type="text/css" href="/styles/pygments.css"/><link rel="stylesheet" type="text/css" href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css"/><link href="//fonts.googleapis.com/css?family=Ubuntu+Mono|Open+Sans" rel="stylesheet" type="text/css"/><link href="/prettify/prettify.css" type="text/css" rel="stylesheet"/><link href="/prettify/sunburst.css" type="text/css" rel="stylesheet"/><script src="//code.jquery.com/jquery.min.js" type="text/javascript"></script><script type="text/javascript" src="/prettify/prettify.js"></script><script type="text/javascript" src="/prettify/fix_code_tags.js"></script></head><body><div class="wrapper"><header class="header"><div class="actions"><iframe src="//ghbtns.com/github-btn.html?user=elasticsearch&amp;repo=elasticsearch-net&amp;type=fork&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="95" height="20"></iframe><iframe src="//ghbtns.com/github-btn.html?user=elasticsearch&amp;repo=elasticsearch-net&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe></div><img src="/images/elasticsearch-net-nuget-icon.png" width="48" height="48"/><h1>Elasticsearch.Net </h1><p>Documentation</p></header><div class="divide"></div><div class="middle"><div class="container"><main class="content"><h1 id="building-requests">Building Requests</h1>
33
<p>This section decribes how to build requests to Elasticsearch.</p>
4-
<h2 id="calling-an-api-endpoint">Calling an API endpoint</h2>
4+
<h2 id="calling-an-api-endpoint">Calling an API Endpoint</h2>
55
<p><code>Elasticsearch.Net</code> maps <strong>all</strong> the <code>Elasticsearch</code> API endpoints to methods. The reason it can do this is because all these methods are generated from
66
<a href="https://github.com/elasticsearch/elasticsearch/tree/master/rest-api-spec/api">the official client rest specification</a>. This specification documents all
77
the URL&#39;s (paths and querystrings) but does not map any of the API request and response bodies.</p>
@@ -17,7 +17,7 @@ <h2 id="calling-an-api-endpoint">Calling an API endpoint</h2>
1717
.Add(&quot;key&quot;,&quot;value&quot;)
1818
);
1919
</code></pre><p>The querystring parameter is always optional.</p>
20-
<h2 id="providing-request-body">Providing request body</h2>
20+
<h2 id="providing-request-body">Providing Request Body</h2>
2121
<p>Some endpoints need a request body this can be passed in a couple of ways.</p>
2222
<h3 id="string">String</h3>
2323
<pre><code>var myJson = @&quot;{ &quot;&quot;hello&quot;&quot; : &quot;&quot;world&quot;&quot; }&quot;;

new_docs/build/elasticsearch-net/errors.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<html><head><title>Nest - Quick Start</title><meta http-equiv="cache-control" content="no-cache"/><meta http-equiv="pragma" content="no-cache"/><meta http-equiv="content-type" content="text/html;charset=utf-8"/><meta http-equiv="expires" content="0"/><meta name="description" content="elasticsearch"/><meta name="keywords" content="nest, elasticsearch, .net, client"/><meta name="author" content="martijn laarman"/><meta name="viewport" content="width=device-width, initial-scale=1"/>
1+
<html><head><title>Nest - Errors</title><meta http-equiv="cache-control" content="no-cache"/><meta http-equiv="pragma" content="no-cache"/><meta http-equiv="content-type" content="text/html;charset=utf-8"/><meta http-equiv="expires" content="0"/><meta name="description" content="elasticsearch"/><meta name="keywords" content="nest, elasticsearch, .net, client"/><meta name="author" content="martijn laarman"/><meta name="viewport" content="width=device-width, initial-scale=1"/>
22
<script src="/scripts/html5shiv.js"></script><link rel="stylesheet" type="text/css" href="/styles/normalize.css"/><link rel="stylesheet" type="text/css" href="/styles/layout.css"/><link rel="stylesheet" type="text/css" href="/styles/pygments.css"/><link rel="stylesheet" type="text/css" href="/styles/pygments.css"/><link rel="stylesheet" type="text/css" href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css"/><link href="//fonts.googleapis.com/css?family=Ubuntu+Mono|Open+Sans" rel="stylesheet" type="text/css"/><link href="/prettify/prettify.css" type="text/css" rel="stylesheet"/><link href="/prettify/sunburst.css" type="text/css" rel="stylesheet"/><script src="//code.jquery.com/jquery.min.js" type="text/javascript"></script><script type="text/javascript" src="/prettify/prettify.js"></script><script type="text/javascript" src="/prettify/fix_code_tags.js"></script></head><body><div class="wrapper"><header class="header"><div class="actions"><iframe src="//ghbtns.com/github-btn.html?user=elasticsearch&amp;repo=elasticsearch-net&amp;type=fork&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="95" height="20"></iframe><iframe src="//ghbtns.com/github-btn.html?user=elasticsearch&amp;repo=elasticsearch-net&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe></div><img src="/images/elasticsearch-net-nuget-icon.png" width="48" height="48"/><h1>Elasticsearch.Net </h1><p>Documentation</p></header><div class="divide"></div><div class="middle"><div class="container"><main class="content"><h1 id="errors">Errors</h1>
33
<p><code>Elasticsearch.Net</code> will not throw if it gets an http response other then 200 from Elasticsearch. The response object&#39;s <code>Success</code> property will be false and <code>.Error</code> will contain information on the failed response.</p>
44
<p>You can throw custom exceptions if you need too by specifying a custom connectionhandler</p>

new_docs/build/elasticsearch-net/handling-responses.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
<html><head><title>Nest - Handling responses</title><meta http-equiv="cache-control" content="no-cache"/><meta http-equiv="pragma" content="no-cache"/><meta http-equiv="content-type" content="text/html;charset=utf-8"/><meta http-equiv="expires" content="0"/><meta name="description" content="elasticsearch"/><meta name="keywords" content="nest, elasticsearch, .net, client"/><meta name="author" content="martijn laarman"/><meta name="viewport" content="width=device-width, initial-scale=1"/>
2-
<script src="/scripts/html5shiv.js"></script><link rel="stylesheet" type="text/css" href="/styles/normalize.css"/><link rel="stylesheet" type="text/css" href="/styles/layout.css"/><link rel="stylesheet" type="text/css" href="/styles/pygments.css"/><link rel="stylesheet" type="text/css" href="/styles/pygments.css"/><link rel="stylesheet" type="text/css" href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css"/><link href="//fonts.googleapis.com/css?family=Ubuntu+Mono|Open+Sans" rel="stylesheet" type="text/css"/><link href="/prettify/prettify.css" type="text/css" rel="stylesheet"/><link href="/prettify/sunburst.css" type="text/css" rel="stylesheet"/><script src="//code.jquery.com/jquery.min.js" type="text/javascript"></script><script type="text/javascript" src="/prettify/prettify.js"></script><script type="text/javascript" src="/prettify/fix_code_tags.js"></script></head><body><div class="wrapper"><header class="header"><div class="actions"><iframe src="//ghbtns.com/github-btn.html?user=elasticsearch&amp;repo=elasticsearch-net&amp;type=fork&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="95" height="20"></iframe><iframe src="//ghbtns.com/github-btn.html?user=elasticsearch&amp;repo=elasticsearch-net&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe></div><img src="/images/elasticsearch-net-nuget-icon.png" width="48" height="48"/><h1>Elasticsearch.Net </h1><p>Documentation</p></header><div class="divide"></div><div class="middle"><div class="container"><main class="content"><h1 id="handling-responses">Handling responses</h1>
1+
<html><head><title>Nest - Handling Responses</title><meta http-equiv="cache-control" content="no-cache"/><meta http-equiv="pragma" content="no-cache"/><meta http-equiv="content-type" content="text/html;charset=utf-8"/><meta http-equiv="expires" content="0"/><meta name="description" content="elasticsearch"/><meta name="keywords" content="nest, elasticsearch, .net, client"/><meta name="author" content="martijn laarman"/><meta name="viewport" content="width=device-width, initial-scale=1"/>
2+
<script src="/scripts/html5shiv.js"></script><link rel="stylesheet" type="text/css" href="/styles/normalize.css"/><link rel="stylesheet" type="text/css" href="/styles/layout.css"/><link rel="stylesheet" type="text/css" href="/styles/pygments.css"/><link rel="stylesheet" type="text/css" href="/styles/pygments.css"/><link rel="stylesheet" type="text/css" href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css"/><link href="//fonts.googleapis.com/css?family=Ubuntu+Mono|Open+Sans" rel="stylesheet" type="text/css"/><link href="/prettify/prettify.css" type="text/css" rel="stylesheet"/><link href="/prettify/sunburst.css" type="text/css" rel="stylesheet"/><script src="//code.jquery.com/jquery.min.js" type="text/javascript"></script><script type="text/javascript" src="/prettify/prettify.js"></script><script type="text/javascript" src="/prettify/fix_code_tags.js"></script></head><body><div class="wrapper"><header class="header"><div class="actions"><iframe src="//ghbtns.com/github-btn.html?user=elasticsearch&amp;repo=elasticsearch-net&amp;type=fork&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="95" height="20"></iframe><iframe src="//ghbtns.com/github-btn.html?user=elasticsearch&amp;repo=elasticsearch-net&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe></div><img src="/images/elasticsearch-net-nuget-icon.png" width="48" height="48"/><h1>Elasticsearch.Net </h1><p>Documentation</p></header><div class="divide"></div><div class="middle"><div class="container"><main class="content"><h1 id="handling-responses">Handling Responses</h1>
33
<p>Describes how to handle the the response objects from <code>Elasticsearch.Net</code></p>
44
<h1 id="elasticsearchresponse-lt-t-gt-">ElasticsearchResponse&lt;T&gt;</h1>
55
<p>This is the container return type for all the API calls. It has the following properties</p>
@@ -20,7 +20,7 @@ <h4 id="responseraw">ResponseRaw</h4>
2020
<a href="/elasticearch-net/connecting.html">see the Connecting section</a></p>
2121
<h4 id="response">Response</h4>
2222
<p>The deserialized <code>T</code> object representing the response.</p>
23-
<h2 id="typed-api-calls">Typed API calls</h2>
23+
<h2 id="typed-api-calls">Typed API Calls</h2>
2424
<p><code>Elasticsearch.Net</code> does not provide typed objects representing the responses this is up to the developer to map. </p>
2525
<pre><code>var result = client.Search&lt;MyType&gt;()
2626
</code></pre><p>In this example <code>MyType</code> is a type you provide to deserialize <code>Elasticsearch</code>&#39;s response to. </p>

0 commit comments

Comments
 (0)