Skip to content

Commit

Permalink
bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
nadar committed Apr 23, 2024
1 parent 77f33e6 commit 0d6cae4
Show file tree
Hide file tree
Showing 32 changed files with 189 additions and 96 deletions.
2 changes: 1 addition & 1 deletion .openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
7.0.1
7.5.0
12 changes: 9 additions & 3 deletions docs/ConfigApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Method | HTTP request | Description

## config

> ConfigResponse config()
> ConfigResponse config(opts)
Get Config

Expand All @@ -28,7 +28,10 @@ ApiToken.apiKey = 'YOUR API KEY';
//ApiToken.apiKeyPrefix = 'Token';

let apiInstance = new FlyoNitroJs.ConfigApi();
apiInstance.config().then((data) => {
let opts = {
'lang': "de" // String | The language context for the current request. If not defined, the defed primary language will be used. If the nitro setup is not configured as multi lingual, the language parameter won't have any effect
};
apiInstance.config(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
Expand All @@ -38,7 +41,10 @@ apiInstance.config().then((data) => {

### Parameters

This endpoint does not need any parameter.

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**lang** | **String**| The language context for the current request. If not defined, the defed primary language will be used. If the nitro setup is not configured as multi lingual, the language parameter won't have any effect | [optional]

### Return type

Expand Down
3 changes: 2 additions & 1 deletion docs/ConfigResponseNitro.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Name | Type | Description | Notes
**slug** | **String** | | [optional]
**version** | **Number** | Whenever Flyo generates new data, the version number will be appropriately incremented. If this value is employed for caching, it will undergo less frequent purging in comparison to the `updated_at` value, thus extending its longevity. (last longer) | [optional]
**updatedAt** | **Number** | A Unix timestamp indicating when the Nitro was last updated. This timestamp does not correlate with the version number. If this value is utilized for caching purposes, it will experience more frequent purges compared to the version number, leading to shorter caching intervals. (last shorter) | [optional]
**language** | **String** | | [optional]
**language** | **String** | Current language context for the config. | [optional]
**primaryLanguage** | **String** | The primary language of the nitro integration | [optional]


20 changes: 13 additions & 7 deletions docs/EntitiesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ All URIs are relative to *https://api.flyo.cloud/nitro/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**entityBySlug**](EntitiesApi.md#entityBySlug) | **GET** /entities/slug/{slug} | Find entity by slug and optional Type-ID
[**entityBySlug**](EntitiesApi.md#entityBySlug) | **GET** /entities/slug/{slug} | Find entity by slug and optional Entity-Type-ID
[**entityByUniqueid**](EntitiesApi.md#entityByUniqueid) | **GET** /entities/uniqueid/{uniqueid} | Find entity by uniqueid


Expand All @@ -13,9 +13,9 @@ Method | HTTP request | Description

> Entity entityBySlug(slug, opts)
Find entity by slug and optional Type-ID

Find entity by slug and optional Entity-Type-ID

The endpoint allows for the retrieval of entities based on their slug, with an optional Entity-Type-ID for more accurate results. The endpoint requires a `slug` parameter to be passed in the path, which is necessary for identifying the entity. However, since slugs are not unique across different entities, it is highly recommended to also provide the `typeId` parameter through the query to avoid incorrect or unintended results. This `typeId` serves as an Entity-Definition-Schema ID, ensuring a more precise and targeted entity retrieval by distinguishing the entities more clearly. The `slug` parameter is mandatory and should be a string (e.g., 'hello-world'), while the `typeId` parameter is optional and should be an integer (e.g., 123), representing the Entity-Definition-Schema ID.

### Example

Expand All @@ -29,8 +29,9 @@ ApiToken.apiKey = 'YOUR API KEY';
//ApiToken.apiKeyPrefix = 'Token';

let apiInstance = new FlyoNitroJs.EntitiesApi();
let slug = hello-world; // String | When looking up an entity slug, it is advisable to provide the typeId parameter along with it, as slugs are not unique among other entities. Failing to include the typeId parameter may lead to unintended or incorrect results. By specifying the typeId, you can ensure more accurate and targeted retrieval of the desired entity.
let slug = "hello-world"; // String | When looking up an entity slug, it is advisable to provide the typeId parameter along with it, as slugs are not unique among other entities. Failing to include the typeId parameter may lead to unintended or incorrect results. By specifying the typeId, you can ensure more accurate and targeted retrieval of the desired entity.
let opts = {
'lang': "de", // String | The language context for the current request. If not defined, the defed primary language will be used. If the nitro setup is not configured as multi lingual, the language parameter won't have any effect
'typeId': 123 // Number | To ensure accurate lookup, it is considered a best practice to include the Type-ID of the entity associated with the slug. The Type-ID, alternatively referred to as the Entity-Definition-Schema ID, serves as a crucial identifier within the system. It uniquely distinguishes and categorizes the Entity-Definition-Schema.
};
apiInstance.entityBySlug(slug, opts).then((data) => {
Expand All @@ -47,6 +48,7 @@ apiInstance.entityBySlug(slug, opts).then((data) => {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**slug** | **String**| When looking up an entity slug, it is advisable to provide the typeId parameter along with it, as slugs are not unique among other entities. Failing to include the typeId parameter may lead to unintended or incorrect results. By specifying the typeId, you can ensure more accurate and targeted retrieval of the desired entity. |
**lang** | **String**| The language context for the current request. If not defined, the defed primary language will be used. If the nitro setup is not configured as multi lingual, the language parameter won't have any effect | [optional]
**typeId** | **Number**| To ensure accurate lookup, it is considered a best practice to include the Type-ID of the entity associated with the slug. The Type-ID, alternatively referred to as the Entity-Definition-Schema ID, serves as a crucial identifier within the system. It uniquely distinguishes and categorizes the Entity-Definition-Schema. | [optional]

### Return type
Expand All @@ -65,7 +67,7 @@ Name | Type | Description | Notes

## entityByUniqueid

> Entity entityByUniqueid(uniqueid)
> Entity entityByUniqueid(uniqueid, opts)
Find entity by uniqueid

Expand All @@ -83,8 +85,11 @@ ApiToken.apiKey = 'YOUR API KEY';
//ApiToken.apiKeyPrefix = 'Token';

let apiInstance = new FlyoNitroJs.EntitiesApi();
let uniqueid = 2348uc; // String | The unique identifier of the given entity is a string composed solely of lowercase alphabetic characters (a-z) and numbers. This identifier is meticulously generated for each data row, ensuring its uniqueness and facilitating efficient data management and retrieval across content pools.
apiInstance.entityByUniqueid(uniqueid).then((data) => {
let uniqueid = "2348uc"; // String | The unique identifier of the given entity is a string composed solely of lowercase alphabetic characters (a-z) and numbers. This identifier is meticulously generated for each data row, ensuring its uniqueness and facilitating efficient data management and retrieval across content pools.
let opts = {
'lang': "de" // String | The language context for the current request. If not defined, the defed primary language will be used. If the nitro setup is not configured as multi lingual, the language parameter won't have any effect
};
apiInstance.entityByUniqueid(uniqueid, opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
Expand All @@ -98,6 +103,7 @@ apiInstance.entityByUniqueid(uniqueid).then((data) => {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**uniqueid** | **String**| The unique identifier of the given entity is a string composed solely of lowercase alphabetic characters (a-z) and numbers. This identifier is meticulously generated for each data row, ensuring its uniqueness and facilitating efficient data management and retrieval across content pools. |
**lang** | **String**| The language context for the current request. If not defined, the defed primary language will be used. If the nitro setup is not configured as multi lingual, the language parameter won't have any effect | [optional]

### Return type

Expand Down
16 changes: 12 additions & 4 deletions docs/PagesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Method | HTTP request | Description

## home

> Page home()
> Page home(opts)
Get Home

Expand All @@ -29,7 +29,10 @@ ApiToken.apiKey = 'YOUR API KEY';
//ApiToken.apiKeyPrefix = 'Token';

let apiInstance = new FlyoNitroJs.PagesApi();
apiInstance.home().then((data) => {
let opts = {
'lang': "de" // String | The language context for the current request. If not defined, the defed primary language will be used. If the nitro setup is not configured as multi lingual, the language parameter won't have any effect
};
apiInstance.home(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
Expand All @@ -39,7 +42,10 @@ apiInstance.home().then((data) => {

### Parameters

This endpoint does not need any parameter.

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**lang** | **String**| The language context for the current request. If not defined, the defed primary language will be used. If the nitro setup is not configured as multi lingual, the language parameter won't have any effect | [optional]

### Return type

Expand Down Expand Up @@ -76,7 +82,8 @@ ApiToken.apiKey = 'YOUR API KEY';

let apiInstance = new FlyoNitroJs.PagesApi();
let opts = {
'slug': foo/bar // String | The function retrieves a specific page by its slug. If no slug is provided, it automatically returns the homepage. Moreover, it seamlessly handles paths with subpages, allowing for nested URLs like \"testpage/subpage\". In this way, a forward slash (\"/\") within the path is recognized as a valid character and processed accordingly.
'lang': "de", // String | The language context for the current request. If not defined, the defed primary language will be used. If the nitro setup is not configured as multi lingual, the language parameter won't have any effect
'slug': "foo/bar" // String | The function retrieves a specific page by its slug. If no slug is provided, it automatically returns the homepage. Moreover, it seamlessly handles paths with subpages, allowing for nested URLs like \"testpage/subpage\". In this way, a forward slash (\"/\") within the path is recognized as a valid character and processed accordingly.
};
apiInstance.page(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
Expand All @@ -91,6 +98,7 @@ apiInstance.page(opts).then((data) => {

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**lang** | **String**| The language context for the current request. If not defined, the defed primary language will be used. If the nitro setup is not configured as multi lingual, the language parameter won't have any effect | [optional]
**slug** | **String**| The function retrieves a specific page by its slug. If no slug is provided, it automatically returns the homepage. Moreover, it seamlessly handles paths with subpages, allowing for nested URLs like \"testpage/subpage\". In this way, a forward slash (\"/\") within the path is recognized as a valid character and processed accordingly. | [optional]

### Return type
Expand Down
10 changes: 7 additions & 3 deletions docs/SearchApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Method | HTTP request | Description

## search

> [EntityinterfaceInner] search(query)
> [EntityinterfaceInner] search(query, opts)
Get Search by query

Expand All @@ -28,8 +28,11 @@ ApiToken.apiKey = 'YOUR API KEY';
//ApiToken.apiKeyPrefix = 'Token';

let apiInstance = new FlyoNitroJs.SearchApi();
let query = foobar; // String | The query keyword that needs to be looked up. It is important to ensure that the query is properly URL encoded for accurate processing and retrieval.
apiInstance.search(query).then((data) => {
let query = "foobar"; // String | The query keyword that needs to be looked up. It is important to ensure that the query is properly URL encoded for accurate processing and retrieval.
let opts = {
'lang': "de" // String | The language context for the current request. If not defined, the defed primary language will be used. If the nitro setup is not configured as multi lingual, the language parameter won't have any effect
};
apiInstance.search(query, opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
Expand All @@ -43,6 +46,7 @@ apiInstance.search(query).then((data) => {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**query** | **String**| The query keyword that needs to be looked up. It is important to ensure that the query is properly URL encoded for accurate processing and retrieval. |
**lang** | **String**| The language context for the current request. If not defined, the defed primary language will be used. If the nitro setup is not configured as multi lingual, the language parameter won't have any effect | [optional]

### Return type

Expand Down
12 changes: 9 additions & 3 deletions docs/SitemapApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Method | HTTP request | Description

## sitemap

> [EntityinterfaceInner] sitemap()
> [EntityinterfaceInner] sitemap(opts)
Get Sitemap

Expand All @@ -28,7 +28,10 @@ ApiToken.apiKey = 'YOUR API KEY';
//ApiToken.apiKeyPrefix = 'Token';

let apiInstance = new FlyoNitroJs.SitemapApi();
apiInstance.sitemap().then((data) => {
let opts = {
'lang': "de" // String | The language context for the current request. If not defined, the defed primary language will be used. If the nitro setup is not configured as multi lingual, the language parameter won't have any effect
};
apiInstance.sitemap(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
Expand All @@ -38,7 +41,10 @@ apiInstance.sitemap().then((data) => {

### Parameters

This endpoint does not need any parameter.

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**lang** | **String**| The language context for the current request. If not defined, the defed primary language will be used. If the nitro setup is not configured as multi lingual, the language parameter won't have any effect | [optional]

### Return type

Expand Down
12 changes: 9 additions & 3 deletions docs/VersionApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Method | HTTP request | Description

## version

> VersionResponse version()
> VersionResponse version(opts)
Get Version Information

Expand All @@ -28,7 +28,10 @@ ApiToken.apiKey = 'YOUR API KEY';
//ApiToken.apiKeyPrefix = 'Token';

let apiInstance = new FlyoNitroJs.VersionApi();
apiInstance.version().then((data) => {
let opts = {
'lang': "de" // String | The language context for the current request. If not defined, the defed primary language will be used. If the nitro setup is not configured as multi lingual, the language parameter won't have any effect
};
apiInstance.version(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
Expand All @@ -38,7 +41,10 @@ apiInstance.version().then((data) => {

### Parameters

This endpoint does not need any parameter.

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**lang** | **String**| The language context for the current request. If not defined, the defed primary language will be used. If the nitro setup is not configured as multi lingual, the language parameter won't have any effect | [optional]

### Return type

Expand Down
2 changes: 1 addition & 1 deletion openapitools.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
"$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
"spaces": 2,
"generator-cli": {
"version": "7.0.1"
"version": "7.5.0"
}
}
8 changes: 4 additions & 4 deletions src/ApiClient.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Flyo Nitro
* This document provides a comprehensive overview of all the endpoints available for Flyo Nitro, a powerful platform designed to facilitate the development of websites. Flyo Nitro is built upon three strategic pillars that play a central role in website development: + Config: The config component is responsible for loading all the necessary elements required for seamless navigation within the website layout. This includes crucial elements like the navigation menu or global content, such as the \"Locations\" section of an entity, which can be utilized in the footer across all pages. + Pages: Pages are evaluated based on their unique slug (path) and encompass all the content needed to populate a specific page. This includes various content elements, known as blocks, as well as meta information like \"og-descriptions.\" Additionally, pages can dynamically incorporate content from entities by employing mapping techniques. + Entity: Entities can be retrieved by utilizing a unique identifier, which can be configured within Flyo Nitro. Each entity provides comprehensive details in the form of fields, offering specific content tailored to a particular context. Furthermore, it is important to distinguish between the **development** and **production** environments in Flyo Nitro. In the development environment, any changes made to data within the Flyo User Interface are immediately accessible, even without saving. This feature enables users to have a live preview of the changes during data entry. On the other hand, the production environment exclusively utilizes saved data, ensuring that only finalized content is displayed. For more detailed documentation in German, please visit: dev.flyo.cloud
*
* The version of the OpenAPI document: 1.0.0-beta.172
* The version of the OpenAPI document: 1.0.0-beta.182
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand All @@ -17,7 +17,7 @@ import querystring from "querystring";

/**
* @module ApiClient
* @version 1.0.0-beta.172
* @version 1.0.0-beta.182
*/

/**
Expand Down Expand Up @@ -55,7 +55,7 @@ class ApiClient {
* @default {}
*/
this.defaultHeaders = {
'User-Agent': 'OpenAPI-Generator/1.0.0-beta.172/Javascript'
'User-Agent': 'OpenAPI-Generator/1.0.0-beta.182/Javascript'
};

/**
Expand Down Expand Up @@ -155,7 +155,7 @@ class ApiClient {
url = apiBasePath + path;
}

url = url.replace(/\{([\w-\.]+)\}/g, (fullMatch, key) => {
url = url.replace(/\{([\w-\.#]+)\}/g, (fullMatch, key) => {
var value;
if (pathParams.hasOwnProperty(key)) {
value = this.paramToString(pathParams[key]);
Expand Down
Loading

0 comments on commit 0d6cae4

Please sign in to comment.