Skip to content

chore(api platform): update application get EP to API V2 - BL21-1719 #233

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wafaBSI wants to merge 1 commit into
base: master
Choose a base branch
from
Open

chore(api platform): update application get EP to API V2 - BL21-1719 #233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions dart-v3/.openapi-generator/FILES
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
.travis.yml
README.md
analysis_options.yaml
doc/AboutJsonhalRead.md
doc/AgreementJsonhalRead.md
doc/ApplicationApi.md
doc/ApplicationJsonhalRead.md
doc/ApplicationJsonhalReadLinks.md
doc/ArchivingJsonhalOrganizationPreferenceRead.md
doc/AssetApi.md
doc/AssetJsonhalRead.md
Expand Down Expand Up @@ -31,10 +36,12 @@ doc/CollaboratorJsonhalRead.md
doc/CollaboratorJsonhalReadEmbedded.md
doc/CollaboratorJsonhalReadLinks.md
doc/ConditionJsonhalRead.md
doc/ConfigurationJsonhalRead.md
doc/ConnectionJsonhalAuthProfileRead.md
doc/ConnectorApi.md
doc/ConnectorJsonhalRead.md
doc/ContactJsonhalRead.md
doc/ContactPointJsonhalApplicationRead.md
doc/ContactPointJsonhalRead.md
doc/ContactPointWrite.md
doc/ContractApi.md
Expand Down Expand Up @@ -143,6 +150,7 @@ doc/NodeJsonhalRead.md
doc/OccupantApi.md
doc/OccupantJsonhalRead.md
doc/OccupantJsonhalReadEmbedded.md
doc/OlderThanJsonhalRead.md
doc/OrganizationJsonhalRead.md
doc/OrganizationJsonhalReadLinks.md
doc/PersonJsonhalRead.md
Expand All @@ -160,6 +168,7 @@ doc/PreferencesJsonhalAssetRead.md
doc/PreferencesJsonhalOrganizationRead.md
doc/PriceJsonhalRead.md
doc/PriceWrite.md
doc/PrivacyPolicyJsonhalRead.md
doc/ProfileJsonhalAuthProfileRead.md
doc/ProfileProfileInput.md
doc/PublicationApi.md
Expand Down Expand Up @@ -199,6 +208,7 @@ doc/SlaPolicyJsonhalReadEmbedded.md
doc/SlaPolicyJsonhalReadLinks.md
doc/TargetGroupApi.md
doc/TargetGroupJsonhalRead.md
doc/TermsOfServiceJsonhalRead.md
doc/TicketApi.md
doc/TicketCreateTicketCommandWrite.md
doc/TicketEditTicketCommandWrite.md
Expand All @@ -220,6 +230,7 @@ doc/WorkflowTransitionJsonhalRead.md
doc/WorkflowTransitionJsonhalReadEmbedded.md
git_push.sh
lib/api.dart
lib/api/application_api.dart
lib/api/asset_api.dart
lib/api/asset_type_api.dart
lib/api/auth_api.dart
Expand Down Expand Up @@ -262,6 +273,10 @@ lib/auth/authentication.dart
lib/auth/http_basic_auth.dart
lib/auth/http_bearer_auth.dart
lib/auth/oauth.dart
lib/model/about_jsonhal_read.dart
lib/model/agreement_jsonhal_read.dart
lib/model/application_jsonhal_read.dart
lib/model/application_jsonhal_read_links.dart
lib/model/archiving_jsonhal_organization_preference_read.dart
lib/model/asset_jsonhal_read.dart
lib/model/asset_jsonhal_read_links.dart
Expand All @@ -283,9 +298,11 @@ lib/model/collaborator_jsonhal_read.dart
lib/model/collaborator_jsonhal_read_embedded.dart
lib/model/collaborator_jsonhal_read_links.dart
lib/model/condition_jsonhal_read.dart
lib/model/configuration_jsonhal_read.dart
lib/model/connection_jsonhal_auth_profile_read.dart
lib/model/connector_jsonhal_read.dart
lib/model/contact_jsonhal_read.dart
lib/model/contact_point_jsonhal_application_read.dart
lib/model/contact_point_jsonhal_read.dart
lib/model/contact_point_write.dart
lib/model/contract_create_contract_command_write.dart
Expand Down Expand Up @@ -382,6 +399,7 @@ lib/model/metric_jsonhal_read.dart
lib/model/node_jsonhal_read.dart
lib/model/occupant_jsonhal_read.dart
lib/model/occupant_jsonhal_read_embedded.dart
lib/model/older_than_jsonhal_read.dart
lib/model/organization_jsonhal_read.dart
lib/model/organization_jsonhal_read_links.dart
lib/model/person_jsonhal_read.dart
Expand All @@ -398,6 +416,7 @@ lib/model/preferences_jsonhal_asset_read.dart
lib/model/preferences_jsonhal_organization_read.dart
lib/model/price_jsonhal_read.dart
lib/model/price_write.dart
lib/model/privacy_policy_jsonhal_read.dart
lib/model/profile_jsonhal_auth_profile_read.dart
lib/model/profile_profile_input.dart
lib/model/publication_jsonhal_read.dart
Expand Down Expand Up @@ -429,6 +448,7 @@ lib/model/sla_policy_jsonhal_read.dart
lib/model/sla_policy_jsonhal_read_embedded.dart
lib/model/sla_policy_jsonhal_read_links.dart
lib/model/target_group_jsonhal_read.dart
lib/model/terms_of_service_jsonhal_read.dart
lib/model/ticket_create_ticket_command_write.dart
lib/model/ticket_edit_ticket_command_write.dart
lib/model/ticket_jsongeo_read.dart
Expand All @@ -445,6 +465,11 @@ lib/model/workflow_state_jsonhal_read.dart
lib/model/workflow_transition_jsonhal_read.dart
lib/model/workflow_transition_jsonhal_read_embedded.dart
pubspec.yaml
test/about_jsonhal_read_test.dart
test/agreement_jsonhal_read_test.dart
test/application_api_test.dart
test/application_jsonhal_read_links_test.dart
test/application_jsonhal_read_test.dart
test/archiving_jsonhal_organization_preference_read_test.dart
test/asset_api_test.dart
test/asset_jsonhal_read_links_test.dart
Expand Down Expand Up @@ -474,10 +499,12 @@ test/collaborator_jsonhal_read_embedded_test.dart
test/collaborator_jsonhal_read_links_test.dart
test/collaborator_jsonhal_read_test.dart
test/condition_jsonhal_read_test.dart
test/configuration_jsonhal_read_test.dart
test/connection_jsonhal_auth_profile_read_test.dart
test/connector_api_test.dart
test/connector_jsonhal_read_test.dart
test/contact_jsonhal_read_test.dart
test/contact_point_jsonhal_application_read_test.dart
test/contact_point_jsonhal_read_test.dart
test/contact_point_write_test.dart
test/contract_api_test.dart
Expand Down Expand Up @@ -586,6 +613,7 @@ test/node_jsonhal_read_test.dart
test/occupant_api_test.dart
test/occupant_jsonhal_read_embedded_test.dart
test/occupant_jsonhal_read_test.dart
test/older_than_jsonhal_read_test.dart
test/organization_jsonhal_read_links_test.dart
test/organization_jsonhal_read_test.dart
test/person_jsonhal_read_test.dart
Expand All @@ -603,6 +631,7 @@ test/preferences_jsonhal_asset_read_test.dart
test/preferences_jsonhal_organization_read_test.dart
test/price_jsonhal_read_test.dart
test/price_write_test.dart
test/privacy_policy_jsonhal_read_test.dart
test/profile_jsonhal_auth_profile_read_test.dart
test/profile_profile_input_test.dart
test/publication_api_test.dart
Expand Down Expand Up @@ -642,6 +671,7 @@ test/sla_policy_jsonhal_read_links_test.dart
test/sla_policy_jsonhal_read_test.dart
test/target_group_api_test.dart
test/target_group_jsonhal_read_test.dart
test/terms_of_service_jsonhal_read_test.dart
test/ticket_api_test.dart
test/ticket_create_ticket_command_write_test.dart
test/ticket_edit_ticket_command_write_test.dart
Expand Down
19 changes: 14 additions & 5 deletions dart-v3/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,20 +45,19 @@ import 'package:keyclic_sdk_api_platform/api.dart';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api_instance = AssetApi();
final identifier = identifier_example; // String | Asset identifier
final api_instance = ApplicationApi();
final identifier = identifier_example; // String | Application identifier
final xKeyclicApp = xKeyclicApp_example; // String |
final xOrganizationId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
final acceptLanguage = acceptLanguage_example; // String |
final xDateTime = 2013-10-20T19:20:30+01:00; // DateTime |
final xKeyclicAppPlatform = xKeyclicAppPlatform_example; // String |
final xKeyclicAppVersion = xKeyclicAppVersion_example; // String |

try {
final result = api_instance.getAsset(identifier, xKeyclicApp, xOrganizationId, acceptLanguage, xDateTime, xKeyclicAppPlatform, xKeyclicAppVersion);
final result = api_instance.getApplication(identifier, xKeyclicApp, acceptLanguage, xDateTime, xKeyclicAppPlatform, xKeyclicAppVersion);
print(result);
} catch (e) {
print('Exception when calling AssetApi->getAsset: $e\n');
print('Exception when calling ApplicationApi->getApplication: $e\n');
}

```
Expand All @@ -69,6 +68,7 @@ All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ApplicationApi* | [**getApplication**](doc//ApplicationApi.md#getapplication) | **GET** /applications/{identifier} | Retrieves a Application resource.
*AssetApi* | [**getAsset**](doc//AssetApi.md#getasset) | **GET** /assets/{identifier} | Retrieves a Asset resource.
*AssetApi* | [**getAssetCollection**](doc//AssetApi.md#getassetcollection) | **GET** /assets | Retrieves the collection of Asset resources.
*AssetTypeApi* | [**getAssetType**](doc//AssetTypeApi.md#getassettype) | **GET** /asset-types/{identifier} | Retrieves a AssetType resource.
Expand Down Expand Up @@ -153,6 +153,10 @@ Class | Method | HTTP request | Description

## Documentation For Models

- [AboutJsonhalRead](doc//AboutJsonhalRead.md)
- [AgreementJsonhalRead](doc//AgreementJsonhalRead.md)
- [ApplicationJsonhalRead](doc//ApplicationJsonhalRead.md)
- [ApplicationJsonhalReadLinks](doc//ApplicationJsonhalReadLinks.md)
- [ArchivingJsonhalOrganizationPreferenceRead](doc//ArchivingJsonhalOrganizationPreferenceRead.md)
- [AssetJsonhalRead](doc//AssetJsonhalRead.md)
- [AssetJsonhalReadLinks](doc//AssetJsonhalReadLinks.md)
Expand All @@ -174,9 +178,11 @@ Class | Method | HTTP request | Description
- [CollaboratorJsonhalReadEmbedded](doc//CollaboratorJsonhalReadEmbedded.md)
- [CollaboratorJsonhalReadLinks](doc//CollaboratorJsonhalReadLinks.md)
- [ConditionJsonhalRead](doc//ConditionJsonhalRead.md)
- [ConfigurationJsonhalRead](doc//ConfigurationJsonhalRead.md)
- [ConnectionJsonhalAuthProfileRead](doc//ConnectionJsonhalAuthProfileRead.md)
- [ConnectorJsonhalRead](doc//ConnectorJsonhalRead.md)
- [ContactJsonhalRead](doc//ContactJsonhalRead.md)
- [ContactPointJsonhalApplicationRead](doc//ContactPointJsonhalApplicationRead.md)
- [ContactPointJsonhalRead](doc//ContactPointJsonhalRead.md)
- [ContactPointWrite](doc//ContactPointWrite.md)
- [ContractCreateContractCommandWrite](doc//ContractCreateContractCommandWrite.md)
Expand Down Expand Up @@ -273,6 +279,7 @@ Class | Method | HTTP request | Description
- [NodeJsonhalRead](doc//NodeJsonhalRead.md)
- [OccupantJsonhalRead](doc//OccupantJsonhalRead.md)
- [OccupantJsonhalReadEmbedded](doc//OccupantJsonhalReadEmbedded.md)
- [OlderThanJsonhalRead](doc//OlderThanJsonhalRead.md)
- [OrganizationJsonhalRead](doc//OrganizationJsonhalRead.md)
- [OrganizationJsonhalReadLinks](doc//OrganizationJsonhalReadLinks.md)
- [PersonJsonhalRead](doc//PersonJsonhalRead.md)
Expand All @@ -289,6 +296,7 @@ Class | Method | HTTP request | Description
- [PreferencesJsonhalOrganizationRead](doc//PreferencesJsonhalOrganizationRead.md)
- [PriceJsonhalRead](doc//PriceJsonhalRead.md)
- [PriceWrite](doc//PriceWrite.md)
- [PrivacyPolicyJsonhalRead](doc//PrivacyPolicyJsonhalRead.md)
- [ProfileJsonhalAuthProfileRead](doc//ProfileJsonhalAuthProfileRead.md)
- [ProfileProfileInput](doc//ProfileProfileInput.md)
- [PublicationJsonhalRead](doc//PublicationJsonhalRead.md)
Expand Down Expand Up @@ -320,6 +328,7 @@ Class | Method | HTTP request | Description
- [SlaPolicyJsonhalReadEmbedded](doc//SlaPolicyJsonhalReadEmbedded.md)
- [SlaPolicyJsonhalReadLinks](doc//SlaPolicyJsonhalReadLinks.md)
- [TargetGroupJsonhalRead](doc//TargetGroupJsonhalRead.md)
- [TermsOfServiceJsonhalRead](doc//TermsOfServiceJsonhalRead.md)
- [TicketCreateTicketCommandWrite](doc//TicketCreateTicketCommandWrite.md)
- [TicketEditTicketCommandWrite](doc//TicketEditTicketCommandWrite.md)
- [TicketJsongeoRead](doc//TicketJsongeoRead.md)
Expand Down
6 changes: 3 additions & 3 deletions dart/doc/ApplicationAbout.md → dart-v3/doc/AboutJsonhalRead.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# keyclic_sdk_api.model.ApplicationAbout
# keyclic_sdk_api_platform.model.AboutJsonhalRead

## Load the model package
```dart
import 'package:keyclic_sdk_api/api.dart';
import 'package:keyclic_sdk_api_platform/api.dart';
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional]
**name** | **String** | |
**text** | **String** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
17 changes: 17 additions & 0 deletions dart-v3/doc/AgreementJsonhalRead.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# keyclic_sdk_api_platform.model.AgreementJsonhalRead

## Load the model package
```dart
import 'package:keyclic_sdk_api_platform/api.dart';
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**olderThan** | [**OlderThanJsonhalRead**](OlderThanJsonhalRead.md) | | [optional]
**privacyPolicy** | [**PrivacyPolicyJsonhalRead**](PrivacyPolicyJsonhalRead.md) | | [optional]
**termsOfService** | [**TermsOfServiceJsonhalRead**](TermsOfServiceJsonhalRead.md) | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


34 changes: 20 additions & 14 deletions dart/doc/ApplicationApi.md → dart-v3/doc/ApplicationApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,36 +1,42 @@
# keyclic_sdk_api.api.ApplicationApi
# keyclic_sdk_api_platform.api.ApplicationApi

## Load the API package
```dart
import 'package:keyclic_sdk_api/api.dart';
import 'package:keyclic_sdk_api_platform/api.dart';
```

All URIs are relative to *https://api.keyclic.com*
All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**getApplication**](ApplicationApi.md#getapplication) | **GET** /applications/{application} | Retrieve one Application resource.
[**getApplication**](ApplicationApi.md#getapplication) | **GET** /applications/{identifier} | Retrieves a Application resource.


# **getApplication**
> Application getApplication(xKeyclicApp, application, acceptLanguage, xDateTime, xKeyclicAppPlatform, xKeyclicAppVersion)
> ApplicationJsonhalRead getApplication(identifier, xKeyclicApp, acceptLanguage, xDateTime, xKeyclicAppPlatform, xKeyclicAppVersion)

Retrieve one Application resource.
Retrieves a Application resource.

Retrieves a Application resource.

### Example
```dart
import 'package:keyclic_sdk_api/api.dart';
import 'package:keyclic_sdk_api_platform/api.dart';
// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

final api_instance = ApplicationApi();
final identifier = identifier_example; // String | Application identifier
final xKeyclicApp = xKeyclicApp_example; // String |
final application = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | The identifier of the resource.
final acceptLanguage = acceptLanguage_example; // String |
final xDateTime = 2013-10-20T19:20:30+01:00; // DateTime |
final xKeyclicAppPlatform = xKeyclicAppPlatform_example; // String |
final xKeyclicAppVersion = xKeyclicAppVersion_example; // String |

try {
final result = api_instance.getApplication(xKeyclicApp, application, acceptLanguage, xDateTime, xKeyclicAppPlatform, xKeyclicAppVersion);
final result = api_instance.getApplication(identifier, xKeyclicApp, acceptLanguage, xDateTime, xKeyclicAppPlatform, xKeyclicAppVersion);
print(result);
} catch (e) {
print('Exception when calling ApplicationApi->getApplication: $e\n');
Expand All @@ -41,25 +47,25 @@ try {

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xKeyclicApp** | **String**| | [default to 'com.keyclic.app']
**application** | **String**| The identifier of the resource. |
**identifier** | **String**| Application identifier |
**xKeyclicApp** | **String**| |
**acceptLanguage** | **String**| | [optional] [default to 'en-US']
**xDateTime** | **DateTime**| | [optional]
**xKeyclicAppPlatform** | **String**| | [optional]
**xKeyclicAppVersion** | **String**| | [optional]

### Return type

[**Application**](Application.md)
[**ApplicationJsonhalRead**](ApplicationJsonhalRead.md)

### Authorization

No authorization required
[apiKey](../README.md#apiKey)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/hal+json;charset=UTF-8
- **Accept**: application/hal+json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

26 changes: 26 additions & 0 deletions dart-v3/doc/ApplicationJsonhalRead.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# keyclic_sdk_api_platform.model.ApplicationJsonhalRead

## Load the model package
```dart
import 'package:keyclic_sdk_api_platform/api.dart';
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**links** | [**ApplicationJsonhalReadLinks**](ApplicationJsonhalReadLinks.md) | | [optional]
**about** | [**AboutJsonhalRead**](AboutJsonhalRead.md) | | [optional]
**agreement** | [**AgreementJsonhalRead**](AgreementJsonhalRead.md) | | [optional]
**configuration** | [**ConfigurationJsonhalRead**](ConfigurationJsonhalRead.md) | | [optional]
**contactPoints** | [**List<ContactPointJsonhalApplicationRead>**](ContactPointJsonhalApplicationRead.md) | | [optional] [default to const []]
**name** | **String** | |
**token** | **String** | The token of the Application, which is used in request application header, to define the context of the current application. |
**version** | **String** | |
**id** | **String** | The resource identifier. | [optional] [readonly]
**createdAt** | [**DateTime**](DateTime.md) | The date and time when the resource was created, in UTC format. | [optional] [readonly]
**updatedAt** | [**DateTime**](DateTime.md) | The date and time when the resource was updated, in UTC format. | [optional] [readonly]
**type** | **String** | | [optional] [readonly]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


16 changes: 16 additions & 0 deletions dart-v3/doc/ApplicationJsonhalReadLinks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# keyclic_sdk_api_platform.model.ApplicationJsonhalReadLinks

## Load the model package
```dart
import 'package:keyclic_sdk_api_platform/api.dart';
```

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**self** | [**GetPlaceCollection200ResponseLinksSelf**](GetPlaceCollection200ResponseLinksSelf.md) | | [optional]
**knowledgeBase** | [**GetPlaceCollection200ResponseLinksFirst**](GetPlaceCollection200ResponseLinksFirst.md) | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


Loading