Commit b35809b0 authored by Matija Obreza's avatar Matija Obreza

Updated documentation

parent 96d7c84e
......@@ -4,10 +4,10 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**wiews** | **String** | | [optional]
**pid** | **String** | | [optional]
**name** | **String** | | [optional]
**address** | **String** | | [optional]
**wiews** | **String** | FAO/WIEWS Institute code | [optional]
**pid** | **String** | Easy-SMTA PID | [optional]
**name** | **String** | Name | [optional]
**address** | **String** | Address | [optional]
**country** | **String** | ISO-3166 apha-3 country code | [optional]
......
......@@ -4,10 +4,10 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**wiews** | **String** | | [optional]
**pid** | **String** | | [optional]
**name** | **String** | | [optional]
**address** | **String** | | [optional]
**wiews** | **String** | FAO/WIEWS Institute code | [optional]
**pid** | **String** | Easy-SMTA PID | [optional]
**name** | **String** | Name | [optional]
**address** | **String** | Address | [optional]
**country** | **String** | ISO-3166 apha-3 country code | [optional]
......
......@@ -123,7 +123,7 @@ Name | Type | Description | Notes
<a name="search"></a>
# **search**
> List&lt;PGRFA&gt; search(page, perPage, doi, identifier, genus, species, name, holdwiews, holdpid, holdname, holdcountry, methodcode, provwiews, provpid, provname, provcountry, provenance, collwiews, collpid, collname, collcountry, bredwiews, bredpid, bredname, bredcountry, biostatus, mlsstatus, targetkw)
> List&lt;PGRFA&gt; search(page, perPage, acceptLanguage, doi, identifier, genus, species, name, holdwiews, holdpid, holdname, holdcountry, methodcode, provwiews, provpid, provname, provcountry, provenance, collwiews, collpid, collname, collcountry, bredwiews, bredpid, bredname, bredcountry, biostatus, mlsstatus, targetkw)
Find passport data on PGRFA in GLIS
......@@ -148,6 +148,7 @@ easySmta.setPassword("YOUR PASSWORD");
QueryApi apiInstance = new QueryApi();
Integer page = 1; // Integer | Request a particular page
Integer perPage = 10; // Integer | The number of items returned in a single page
List<String> acceptLanguage = Arrays.asList("en"); // List<String> | Tags to filter by
String doi = "doi_example"; // String | Digital Object Identifier (DOI) associated to the PGRFA
String identifier = "identifier_example"; // String | Any identifier associated with the PGRFA, excluding the DOI
String genus = "genus_example"; // String | Genus of the PGRFA
......@@ -175,7 +176,7 @@ String biostatus = "biostatus_example"; // String | Code of the biological statu
String mlsstatus = "mlsstatus_example"; // String | Code for the inclusion into the Multilateral System.
String targetkw = "targetkw_example"; // String | Code for the keyword for a target associated to the PGRFA. To obtain the list of keyword codes, please see \"Controlled vocabulary query\".
try {
List<PGRFA> result = apiInstance.search(page, perPage, doi, identifier, genus, species, name, holdwiews, holdpid, holdname, holdcountry, methodcode, provwiews, provpid, provname, provcountry, provenance, collwiews, collpid, collname, collcountry, bredwiews, bredpid, bredname, bredcountry, biostatus, mlsstatus, targetkw);
List<PGRFA> result = apiInstance.search(page, perPage, acceptLanguage, doi, identifier, genus, species, name, holdwiews, holdpid, holdname, holdcountry, methodcode, provwiews, provpid, provname, provcountry, provenance, collwiews, collpid, collname, collcountry, bredwiews, bredpid, bredname, bredcountry, biostatus, mlsstatus, targetkw);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling QueryApi#search");
......@@ -189,6 +190,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**page** | **Integer**| Request a particular page | [optional] [default to 1]
**perPage** | **Integer**| The number of items returned in a single page | [optional] [default to 10]
**acceptLanguage** | [**List&lt;String&gt;**](String.md)| Tags to filter by | [optional] [default to en] [enum: en, fr, es, ar, ru, zh]
**doi** | **String**| Digital Object Identifier (DOI) associated to the PGRFA | [optional]
**identifier** | **String**| Any identifier associated with the PGRFA, excluding the DOI | [optional]
**genus** | **String**| Genus of the PGRFA | [optional]
......
......@@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**subject** | **String** | The DOI of the PGRFA subject that was provided as search value | [optional]
**oper** | **String** | The DOI of the PGRFA subject that was provided as search value | [optional]
**oper** | **String** | The code of the relation operator. | [optional]
**object** | **String** | The DOI of the PGRFA related to subject through oper | [optional]
......
......@@ -4,8 +4,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**url** | **String** | | [optional]
**kws** | **List&lt;String&gt;** | | [optional]
**url** | **String** | URL to PGRFA information | [optional]
**kws** | **List&lt;String&gt;** | Keywords? | [optional]
......@@ -4,9 +4,9 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **String** | Unique term code | [optional]
**language** | [**LanguageEnum**](#LanguageEnum) | ISO-639-1 two-letter language code | [optional]
**term** | **String** | Term | [optional]
**code** | **String** | Unique term code |
**language** | [**LanguageEnum**](#LanguageEnum) | ISO-639-1 two-letter language code |
**term** | **String** | Term |
<a name="LanguageEnum"></a>
......
......@@ -4,7 +4,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**modified** | [**DateTime**](DateTime.md) | | [optional]
**modified** | [**DateTime**](DateTime.md) | The date of last change. | [optional]
**doiregistered** | [**DateTime**](DateTime.md) | The date of DOI registration to the DataCite registry. If this element is missing or null, the DOI has not been registered yet and should therefore not be used in publications | [optional]
......
......@@ -492,7 +492,7 @@ definitions:
oper:
type: string
description: >-
The DOI of the PGRFA subject that was provided as search value
The code of the relation operator.
object:
type: string
description: >-
......@@ -697,20 +697,20 @@ definitions:
properties:
wiews:
type: string
title: FAO/WIEWS Institute code
description: FAO/WIEWS Institute code
pattern: '^[A-Z]{3}[0-9]{3,4}$'
example: 'NLD037'
pid:
type: string
title: Easy-SMTA PID
description: Easy-SMTA PID
example: '1337'
name:
type: string
title: Name
description: Name
example: 'Centre for Genetic Resources, Wageningen University and Research Centre'
address:
type: string
title: Address
description: Address
example: '6700 AA Wageningen, The Netherlands'
country:
type: string
......@@ -729,24 +729,31 @@ definitions:
properties:
lat:
type: number
title: Latitude in decimal degrees
description: Latitude in decimal degrees
lon:
type: number
title: Longitude in decimal degrees
description: Longitude in decimal degrees
Target:
type: object
description: >-
The website where additional information on the PGRFA can be found.
properties:
url:
type: string
description: URL to PGRFA information
kws:
type: array
description: Keywords?
items:
type: string
Names:
type: object
description: >-
Registered names or other designations, such as the name of a landrace, traditional variety or modern cultivar, or some other name or designation used to identify a breeder’s selection or elite line or variety.
properties:
genus:
type: string
description: >-
names:
type: array
items:
......@@ -788,11 +795,13 @@ definitions:
modified:
type: string
format: date-time
doiregistered:
description: >-
The date of DOI registration to the DataCite registry. If this element is missing or null, the DOI has not been registered yet and should therefore not be used in publications
The date of last change.
doiregistered:
type: string
format: date-time
description: >-
The date of DOI registration to the DataCite registry. If this element is missing or null, the DOI has not been registered yet and should therefore not be used in publications
ApiError:
type: object
properties:
......
Markdown is supported
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