Commit 38296993 authored by Matija Obreza's avatar Matija Obreza
Browse files

Updated README.md with swagger-codegen info

parent b2649c5f
......@@ -110,43 +110,39 @@ public class PgrfaApiExample {
}
}
}
```
## Documentation for API Endpoints
Calls to GLIS API require HTTP basic authentication with credentials from Easy-SMTA.
All URIs are relative to *https://glistest.planttreaty.org/glisapi/v1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*PgrfaApi* | [**search**](docs/PgrfaApi.md#search) | **GET** /pgrfas | Find passport data on PGRFA in GLIS
*RelsApi* | [**listRelationships**](docs/RelsApi.md#listRelationships) | **GET** /rels | Get PGRFA relationships
*TermsApi* | [**listTerms**](docs/TermsApi.md#listTerms) | **GET** /terms | GLIS vocabularies
All URIs are relative to _<https://glistest.planttreaty.org/glisapi/v1>_
Class | Method | HTTP request | Description
---------- | ---------------------------------------------------------- | --------------- | -----------------------------------
_PgrfaApi_ | [**search**](docs/PgrfaApi.md#search) | **GET** /pgrfas | Find passport data on PGRFA in GLIS
_RelsApi_ | [**listRelationships**](docs/RelsApi.md#listRelationships) | **GET** /rels | Get PGRFA relationships
_TermsApi_ | [**listTerms**](docs/TermsApi.md#listTerms) | **GET** /terms | GLIS vocabularies
## Documentation for Models
- [ApiError](docs/ApiError.md)
- [Location](docs/Location.md)
- [Names](docs/Names.md)
- [OtherIdentifier](docs/OtherIdentifier.md)
- [PGRFA](docs/PGRFA.md)
- [RateLimitError](docs/RateLimitError.md)
- [Relationship](docs/Relationship.md)
- [Species](docs/Species.md)
- [Target](docs/Target.md)
- [Term](docs/Term.md)
- [TermValue](docs/TermValue.md)
- [UpdateInformation](docs/UpdateInformation.md)
- [ApiError](docs/ApiError.md)
- [Location](docs/Location.md)
- [Names](docs/Names.md)
- [OtherIdentifier](docs/OtherIdentifier.md)
- [PGRFA](docs/PGRFA.md)
- [RateLimitError](docs/RateLimitError.md)
- [Relationship](docs/Relationship.md)
- [Species](docs/Species.md)
- [Target](docs/Target.md)
- [Term](docs/Term.md)
- [TermValue](docs/TermValue.md)
- [UpdateInformation](docs/UpdateInformation.md)
## Recommendation
It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.
# Development of the library
1. Updarte `glis.yml` definition
......@@ -165,3 +161,9 @@ To see debug output of API calls set envonment variable `GLIS_DEBUG=true`:
```bash
GLIS_DEBUG=true GLIS_USERNAME=your_username GLIS_PASSWORD=your_password mvn test -DskipTests=false
```
# Other platforms
[Swagger Codegen](http://swagger.io/swagger-codegen/) can generate client SDKs for C#, Android, C++, Haskell, Javascript, Groovy, ObjC, Perl, PHP, Python, etc.
Use our [glis.yml](/src/main/resources/swagger/v1/glis.yml) to generate the API for your preferred language. If decide to make your library publicly accessible, please let us know and we'll link it here!
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