Skip to content

Commit d2f7cd4

Browse files
committed
DOC-1740: Product Search Config Options
1 parent ba5179a commit d2f7cd4

File tree

271 files changed

+1630
-1636
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

271 files changed

+1630
-1636
lines changed

_themes/sphinx_rtd_theme/static/css/redesign.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ a:focus {
159159
.rst-content div[class*='highlight'] pre,
160160
.rst-content .linenodiv pre {
161161
font-size: 12px;
162-
line-height: 24px;
162+
line-height: 17px;
163163
padding: 0 13px;
164164
}
165165
.rst-content .linenodiv pre {

api/advanced-search.rst

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -46,22 +46,22 @@ should consist the type prefix, otherwise the default ``text`` type will
4646
be used.
4747

4848
.. code-block:: none
49-
:linenos:
49+
5050
5151
select text.field_name
5252
select (text.first_field_name, text.second_field_name)
5353
5454
You can use fieldname aliasing, as known in SQL, for example:
5555

5656
.. code-block:: none
57-
:linenos:
57+
5858
5959
select text.field_1 as name, text.field_2 as author
6060
6161
You can use fieldname aliasing, as known in SQL, for example:
6262

6363
.. code-block:: none
64-
:linenos:
64+
6565
6666
select (text.field_1 as name, text.field_2 as author)
6767
@@ -74,7 +74,7 @@ A list of entity aliases to search from. It can be one alias or group.
7474
Examples:
7575

7676
.. code-block:: none
77-
:linenos:
77+
7878
7979
from one_alias
8080
from (first_alias, second_alias)
@@ -92,7 +92,7 @@ and, or
9292
Syntax:
9393

9494
.. code-block:: none
95-
:linenos:
95+
9696
9797
and field_type field_name operator value
9898
or field_type field_name operator value
@@ -117,7 +117,7 @@ The ``order_by`` clause allows to sort results in ascending or descending order.
117117
Syntax:
118118

119119
.. code-block:: none
120-
:linenos:
120+
121121
122122
order_by field_type field_name direction
123123
@@ -144,7 +144,7 @@ For String Fields
144144
If search value is string, it must be quoted. Examples:
145145

146146
.. code-block:: none
147-
:linenos:
147+
148148
149149
name ~ value
150150
name ~ "string value"
@@ -154,7 +154,7 @@ For String Fields
154154
Examples:
155155

156156
.. code-block:: none
157-
:linenos:
157+
158158
159159
name !~ value
160160
name !~ "string value"
@@ -165,7 +165,7 @@ For String Fields
165165
whitespaces, it should be enclosed in quotes. Examples:
166166

167167
.. code-block:: none
168-
:linenos:
168+
169169
170170
name like value
171171
name like "string value"
@@ -176,7 +176,7 @@ For String Fields
176176
contains whitespaces, it should be enclosed in quotes. Examples:
177177

178178
.. code-block:: none
179-
:linenos:
179+
180180
181181
name notlike value
182182
name notlike "string value"
@@ -188,7 +188,7 @@ For Numeric Fields
188188
field value matches the specified value. Examples:
189189

190190
.. code-block:: none
191-
:linenos:
191+
192192
193193
integer count = 100
194194
decimal price = 12.5
@@ -198,7 +198,7 @@ For Numeric Fields
198198
where the field value does not match the specified value. Examples:
199199

200200
.. code-block:: none
201-
:linenos:
201+
202202
203203
integer count != 5
204204
decimal price != 45
@@ -209,7 +209,7 @@ For Numeric Fields
209209
specified value. Examples:
210210

211211
.. code-block:: none
212-
:linenos:
212+
213213
214214
integer count >= 5
215215
decimal price < 45
@@ -219,7 +219,7 @@ For Numeric Fields
219219
the specified set of data. Examples:
220220

221221
.. code-block:: none
222-
:linenos:
222+
223223
224224
integer count in (5, 10, 15, 20)
225225
decimal price in (12.2, 55.25)
@@ -228,7 +228,7 @@ For Numeric Fields
228228
in the specified set of data. Examples:
229229

230230
.. code-block:: none
231-
:linenos:
231+
232232
233233
integer count !in (1, 3, 5)
234234
decimal price !in (2.1, 55, 45.4)
@@ -241,7 +241,7 @@ User can combined operators in the search query with brackets.
241241
Examples:
242242

243243
.. code-block:: none
244-
:linenos:
244+
245245
246246
from oro_test where (owner ~ john and (integer count > 10 or float price = 10)) or (owner ~ mary and (integer count > 5 or float price = 150))
247247
@@ -252,30 +252,30 @@ Query Examples
252252
and where the price is greater than ``100``.
253253

254254
.. code-block:: none
255-
:linenos:
255+
256256
257257
from demo_product where name ~ opportunity and double price > 100
258258
259259
- Search and return entity data plus the name and the description of demo
260260
products.
261261

262262
.. code-block:: none
263-
:linenos:
263+
264264
265265
select (name, description) from demo_product
266266
267267
- Search by all entities where the integer field count is not equal ``10``.
268268

269269
.. code-block:: none
270-
:linenos:
270+
271271
272272
integer count != 10
273273
274274
- Search by all entities where text field ``all_text`` does not contain the
275275
``opportunity`` string.
276276

277277
.. code-block:: none
278-
:linenos:
278+
279279
280280
all_text !~ "opportunity"
281281

api/authentication/oauth-authorization-code.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,15 +59,15 @@ To configure the authentication via the authorization code grant type and to ret
5959
Request
6060

6161
.. code-block:: http
62-
:linenos:
62+
6363
6464
POST /oauth2-token HTTP/1.1
6565
Content-Type: application/json
6666
6767
Request Body
6868

6969
.. code-block:: json
70-
:linenos:
70+
7171
7272
{
7373
"grant_type": "authorization_code",
@@ -80,7 +80,7 @@ Request Body
8080
Response Body
8181

8282
.. code-block:: json
83-
:linenos:
83+
8484
8585
{
8686
"token_type": "Bearer",
@@ -94,7 +94,7 @@ the previous token expires.
9494
An example of an API request:
9595

9696
.. code-block:: http
97-
:linenos:
97+
9898
9999
GET /api/users HTTP/1.1
100100
Accept: application/vnd.api+json

api/authentication/oauth-client-credentials.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@ To configure the authentication via the client credentials grant type and retrie
3232
Request
3333

3434
.. code-block:: http
35-
:linenos:
35+
3636
3737
POST /oauth2-token HTTP/1.1
3838
Content-Type: application/json
3939
4040
Request Body
4141

4242
.. code-block:: json
43-
:linenos:
43+
4444
4545
{
4646
"grant_type": "client_credentials",
@@ -51,7 +51,7 @@ Request Body
5151
Response Body
5252

5353
.. code-block:: json
54-
:linenos:
54+
5555
5656
{
5757
"token_type": "Bearer",
@@ -65,7 +65,7 @@ the previous token expires.
6565
An example of an API request:
6666

6767
.. code-block:: http
68-
:linenos:
68+
6969
7070
GET /api/users HTTP/1.1
7171
Accept: application/vnd.api+json

api/authentication/oauth-password-refresh.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@ Follow the next steps to get a new token:
3636
Request
3737

3838
.. code-block:: http
39-
:linenos:
39+
4040
4141
POST /oauth2-token HTTP/1.1
4242
Content-Type: application/json
4343
4444
Request Body
4545

4646
.. code-block:: json
47-
:linenos:
47+
4848
4949
{
5050
"grant_type": "refresh_token",
@@ -56,7 +56,7 @@ Request Body
5656
Response Body
5757

5858
.. code-block:: json
59-
:linenos:
59+
6060
6161
{
6262
"token_type": "Bearer",

api/authentication/oauth-password.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,15 @@ To configure the authentication via the password grant type and retrieve the acc
3535
Request
3636

3737
.. code-block:: http
38-
:linenos:
38+
3939
4040
POST /oauth2-token HTTP/1.1
4141
Content-Type: application/json
4242
4343
Request Body
4444

4545
.. code-block:: json
46-
:linenos:
46+
4747
4848
{
4949
"grant_type": "password",
@@ -56,7 +56,7 @@ Request Body
5656
Response Body
5757

5858
.. code-block:: json
59-
:linenos:
59+
6060
6161
{
6262
"token_type": "Bearer",
@@ -70,7 +70,7 @@ The received access token can be used multiple times until it expires.
7070
An example of an API request:
7171

7272
.. code-block:: http
73-
:linenos:
73+
7474
7575
GET /api/users HTTP/1.1
7676
Accept: application/vnd.api+json

api/authentication/wsse.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Header Generation
6767
The console command ``oro:wsse:generate-header`` can be used to generate an authentication header.
6868

6969
.. code-block:: bash
70-
:linenos:
70+
7171
7272
user@host: php bin/console oro:wsse:generate-header yourApiKey
7373
Authorization: WSSE profile="UsernameToken"
@@ -78,7 +78,7 @@ It has *apiKey* as the required argument and outputs generated headers.
7878
An example of an authentication header generation with PHP:
7979

8080
.. code-block:: php
81-
:linenos:
81+
8282
8383
$userName = 'your username';
8484
$userApiKey = 'your apiKey';
@@ -114,7 +114,7 @@ Here's an example of a REST API request header with the WSSE authentication.
114114
Please pay attention to the **Authentication** and **X-WSSE** parameters:
115115

116116
.. code-block:: http
117-
:linenos:
117+
118118
119119
GET /api/users HTTP/1.1
120120
Accept: application/vnd.api+json

0 commit comments

Comments
 (0)