Commit 9d6c37cf authored by neelesh thakur's avatar neelesh thakur
Browse files

update documentation

parent 639dfce6
Pipeline #45558 passed with stages
in 78 minutes and 25 seconds
...@@ -297,7 +297,7 @@ definitions: ...@@ -297,7 +297,7 @@ definitions:
type: integer type: integer
format: int32 format: int32
minimum: 0 minimum: 0
description: The maximum number of results to return from the given offset. If no limit is provided, then it will return 10 items. Max number of items which can be fetched by the query is 100. description: The maximum number of results to return from the given offset. If no limit is provided, then it will return 10 items. Max number of items which can be fetched by the query is 1000.
query: query:
type: string type: string
description: The query string in Lucene query string syntax. description: The query string in Lucene query string syntax.
...@@ -369,7 +369,7 @@ definitions: ...@@ -369,7 +369,7 @@ definitions:
type: integer type: integer
format: int32 format: int32
minimum: 0 minimum: 0
description: The maximum number of results to return from the given offset. If no limit is provided, then it will return 10 items. Max number of items which can be fetched by the query is 100. description: The maximum number of results to return from the given offset. If no limit is provided, then it will return 10 items. Max number of items which can be fetched by the query is 1000.
query: query:
type: string type: string
description: The query string in Lucene query string syntax. description: The query string in Lucene query string syntax.
......
...@@ -146,7 +146,7 @@ __Note:__ : It can take a delay of atleast 30 seconds once records are successfu ...@@ -146,7 +146,7 @@ __Note:__ : It can take a delay of atleast 30 seconds once records are successfu
| kind | The kind of the record to query e.g. 'common:welldb:wellbore:1.0.0'. kind is a __required__ field and can be formatted as OSDU-Data-Partition-Id:data-source-id:entity-type:schema-version | | kind | The kind of the record to query e.g. 'common:welldb:wellbore:1.0.0'. kind is a __required__ field and can be formatted as OSDU-Data-Partition-Id:data-source-id:entity-type:schema-version |
| query | Query string based on Lucene query string syntax, supplemented with a specific format for describing queries to fields of object arrays indexed with the "nested" hint. | | query | Query string based on Lucene query string syntax, supplemented with a specific format for describing queries to fields of object arrays indexed with the "nested" hint. |
| offset | The starting offset from which to return results. | | offset | The starting offset from which to return results. |
| limit | The maximum number of results to return from the given offset. If no limit is provided, then it will return __10__ items. Max number of items which can be fetched by the query is __100__. (If you wish to fetch large set of items, please use [query_with_cursor](#query-with-cursor) API). | | limit | The maximum number of results to return from the given offset. If no limit is provided, then it will return __10__ items. Max number of items which can be fetched by the query is __1000__. (If you wish to fetch large set of items, please use [query_with_cursor](#query-with-cursor) API). |
| sort | Allows you to add one or more sorts on specific fields. The length of fields and the length of order must match. Order value must be either ASC or DESC (case insensitive). For more details, ability and limitation about this feature, please refer to [Sort](#sort_querires) | sort | Allows you to add one or more sorts on specific fields. The length of fields and the length of order must match. Order value must be either ASC or DESC (case insensitive). For more details, ability and limitation about this feature, please refer to [Sort](#sort_querires)
| queryAsOwner | If true, the result only contains the records that the user owns. If false, the result contains all records that the user is entitled to see. Default value is false | | queryAsOwner | If true, the result only contains the records that the user owns. If false, the result contains all records that the user is entitled to see. Default value is false |
| spatialFilter | A spatial filter to apply, please see [Geo-Spatial Queries](#geo-spatial-queries). | | spatialFilter | A spatial filter to apply, please see [Geo-Spatial Queries](#geo-spatial-queries). |
......
...@@ -39,7 +39,7 @@ ...@@ -39,7 +39,7 @@
<aws.version>1.11.637</aws.version> <aws.version>1.11.637</aws.version>
<deployment.environment>dev</deployment.environment> <deployment.environment>dev</deployment.environment>
<version.number>0.0.4-SNAPSHOT</version.number> <version.number>0.0.4-SNAPSHOT</version.number>
<osdu.oscorecommon.version>0.9.0-rc4</osdu.oscorecommon.version> <osdu.oscorecommon.version>0.9.0</osdu.oscorecommon.version>
</properties> </properties>
<dependencies> <dependencies>
......
...@@ -37,7 +37,7 @@ ...@@ -37,7 +37,7 @@
<project.main.basedir>${project.parent.basedir}</project.main.basedir> <project.main.basedir>${project.parent.basedir}</project.main.basedir>
<springboot.version>2.1.7.RELEASE</springboot.version> <springboot.version>2.1.7.RELEASE</springboot.version>
<osdu.corelibazure.version>0.9.0-rc1</osdu.corelibazure.version> <osdu.corelibazure.version>0.9.0-rc1</osdu.corelibazure.version>
<osdu.oscorecommon.version>0.9.0-rc4</osdu.oscorecommon.version> <osdu.oscorecommon.version>0.9.0</osdu.oscorecommon.version>
<osdu.search-core.version>0.10.0-SNAPSHOT</osdu.search-core.version> <osdu.search-core.version>0.10.0-SNAPSHOT</osdu.search-core.version>
<spatial4j.version>0.7</spatial4j.version> <spatial4j.version>0.7</spatial4j.version>
<jts-io-common.version>1.15.0</jts-io-common.version> <jts-io-common.version>1.15.0</jts-io-common.version>
......
...@@ -48,7 +48,7 @@ ...@@ -48,7 +48,7 @@
<dependency> <dependency>
<groupId>org.opengroup.osdu</groupId> <groupId>org.opengroup.osdu</groupId>
<artifactId>os-core-common</artifactId> <artifactId>os-core-common</artifactId>
<version>0.9.0-rc4</version> <version>0.9.0</version>
</dependency> </dependency>
<dependency> <dependency>
......
...@@ -25,7 +25,7 @@ ...@@ -25,7 +25,7 @@
<properties> <properties>
<os-core-lib-ibm.version>0.10.0-SNAPSHOT</os-core-lib-ibm.version> <os-core-lib-ibm.version>0.10.0-SNAPSHOT</os-core-lib-ibm.version>
<start-class>org.opengroup.osdu.search.provider.ibm.app.SearchIBMApplication</start-class> <start-class>org.opengroup.osdu.search.provider.ibm.app.SearchIBMApplication</start-class>
<osdu.oscorecommon.version>0.9.0-rc4</osdu.oscorecommon.version> <osdu.oscorecommon.version>0.9.0</osdu.oscorecommon.version>
</properties> </properties>
......
...@@ -33,7 +33,7 @@ ...@@ -33,7 +33,7 @@
<dependency> <dependency>
<groupId>org.opengroup.osdu</groupId> <groupId>org.opengroup.osdu</groupId>
<artifactId>os-core-common</artifactId> <artifactId>os-core-common</artifactId>
<version>0.9.0-rc4</version> <version>0.9.0</version>
</dependency> </dependency>
<dependency> <dependency>
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment