Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Doc - fix build (#5957) 

- remove blank spaces in REST-blocks
- add missing link
- remove type from "@RESTSTRUCT{[field-name],post_api_view_fields,,optional,post_api_view_field_props}"
- replace in @RESTHEADER#<view-type> with #arangosearch
This commit is contained in:
maxkernbach 2018-07-23 16:15:47 +02:00 committed by sleto-it
parent 718e3f7bfa
commit c7bf99f91b
9 changed files with 85 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Documentation/Books/HTTP/SUMMARY.md
View File

@ -44,6 +44,7 @@
* [Fulltext](Indexes/Fulltext.md) * [Fulltext](Indexes/Fulltext.md)
* [Views](Views/README.md) * [Views](Views/README.md)
* [Creating](Views/Creating.md) * [Creating](Views/Creating.md)
* [Deleting](Views/Dropping.md)
* [Modifying](Views/Modifying.md) * [Modifying](Views/Modifying.md)
* [Retrieving](Views/Getting.md) * [Retrieving](Views/Getting.md)
* [ArangoSearch Views](Views/ArangoSearch.md) * [ArangoSearch Views](Views/ArangoSearch.md)

2
Documentation/DocuBlocks/Rest/Views/patch_api_view_properties.md
View File

@ -1,7 +1,7 @@
@startDocuBlock patch_api_view_properties @startDocuBlock patch_api_view_properties
@brief partially changes properties of an ArangoDB view @brief partially changes properties of an ArangoDB view
@RESTHEADER{PATCH /_api/view/{view-name}/properties#<view-type>, Partially changes properties of an ArangoDB view} @RESTHEADER{PATCH /_api/view/{view-name}/properties#arangosearch, Partially changes properties of an ArangoDB view}
@RESTURLPARAMETERS @RESTURLPARAMETERS

2
Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md
View File

@ -97,7 +97,7 @@ The list of analyzers to be used for indexing of string values
The field properties. If specified, then *properties* should be a JSON object The field properties. If specified, then *properties* should be a JSON object
containing the following attributes: containing the following attributes:
@RESTSTRUCT{[field-name], post_api_view_fields, array, optional, post_api_view_field_props} @RESTSTRUCT{[field-name],post_api_view_fields,,optional,post_api_view_field_props}
This is a recursive structure for the specific attribute path, potentially This is a recursive structure for the specific attribute path, potentially
containing any of the following attributes: containing any of the following attributes:
*analyzers*, *includeAllFields*, *trackListPositions*, *trackValues* *analyzers*, *includeAllFields*, *trackListPositions*, *trackValues*

2
Documentation/DocuBlocks/Rest/Views/post_api_view.md
View File

@ -1,7 +1,7 @@
@startDocuBlock post_api_view @startDocuBlock post_api_view
@brief creates an ArangoDB view @brief creates an ArangoDB view
@RESTHEADER{POST /_api/view#<view-type>, Create an ArangoDB view} @RESTHEADER{POST /_api/view#arangosearch, Create an ArangoDB view}
@RESTBODYPARAM{name,string,required,string} @RESTBODYPARAM{name,string,required,string}
The name of the view. The name of the view.

2
Documentation/DocuBlocks/Rest/Views/put_api_view_properties.md
View File

@ -1,7 +1,7 @@
@startDocuBlock put_api_view_properties @startDocuBlock put_api_view_properties
@brief changes properties of an ArangoDB view @brief changes properties of an ArangoDB view
@RESTHEADER{PUT /_api/view/{view-name}/properties#<view-type>, Change properties of an ArangoDB view} @RESTHEADER{PUT /_api/view/{view-name}/properties#arangosearch, Change properties of an ArangoDB view}
@RESTURLPARAMETERS @RESTURLPARAMETERS

4
Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md
View File

@ -92,18 +92,16 @@ containing the following attributes:
The list of analyzers to be used for indexing of string values The list of analyzers to be used for indexing of string values
(default: ["identity"]). (default: ["identity"]).
@RESTSTRUCT{fields,post_api_view_link_props,object,optional,post_api_view_fields} @RESTSTRUCT{fields,post_api_view_link_props,object,optional,post_api_view_fields}
The field properties. If specified, then *properties* should be a JSON object The field properties. If specified, then *properties* should be a JSON object
containing the following attributes: containing the following attributes:
@RESTSTRUCT{[field-name], post_api_view_fields, array, optional, post_api_view_field_props} @RESTSTRUCT{[field-name],post_api_view_fields,,optional,post_api_view_field_props}
This is a recursive structure for the specific attribute path, potentially This is a recursive structure for the specific attribute path, potentially
containing any of the following attributes: containing any of the following attributes:
*analyzers*, *includeAllFields*, *trackListPositions*, *trackValues* *analyzers*, *includeAllFields*, *trackListPositions*, *trackValues*
Any attributes not specified are inherited from the parent. Any attributes not specified are inherited from the parent.
@RESTSTRUCT{includeAllFields,post_api_view_link_props,boolean,optional,bool} @RESTSTRUCT{includeAllFields,post_api_view_link_props,boolean,optional,bool}
The flag determines whether or not to index all fields on a particular level of The flag determines whether or not to index all fields on a particular level of
depth (default: false). depth (default: false).