@teemill/blog 0.3.0 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @teemill/blog@0.3.0
1
+ ## @teemill/blog@0.3.1
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @teemill/blog@0.3.0 --save
39
+ npm install @teemill/blog@0.3.1 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -44,3 +44,48 @@ _unPublished (not recommended):_
44
44
  ```
45
45
  npm install PATH_TO_GENERATED_PACKAGE --save
46
46
  ```
47
+
48
+ ### Documentation for API Endpoints
49
+
50
+ All URIs are relative to *https://localhost:8080*
51
+
52
+ Class | Method | HTTP request | Description
53
+ ------------ | ------------- | ------------- | -------------
54
+ *BlogApi* | [**createBlog**](docs/BlogApi.md#createblog) | **POST** /v1/blog/blogs | Create a blog
55
+ *BlogApi* | [**deleteBlog**](docs/BlogApi.md#deleteblog) | **DELETE** /v1/blog/blogs/{blogId} | Delete a blog
56
+ *BlogApi* | [**getBlog**](docs/BlogApi.md#getblog) | **GET** /v1/blog/blogs/{blogId} | Get a blog
57
+ *BlogApi* | [**listBlogs**](docs/BlogApi.md#listblogs) | **GET** /v1/blog/blogs | List blogs
58
+ *BlogApi* | [**updateBlog**](docs/BlogApi.md#updateblog) | **PATCH** /v1/blog/blogs/{blogId} | Update a blog
59
+
60
+
61
+ ### Documentation For Models
62
+
63
+ - [ApiError](docs/ApiError.md)
64
+ - [Blog](docs/Blog.md)
65
+ - [BlogListing](docs/BlogListing.md)
66
+ - [BlogListingType](docs/BlogListingType.md)
67
+ - [CreateBlogRequest](docs/CreateBlogRequest.md)
68
+ - [ListBlogsResponse](docs/ListBlogsResponse.md)
69
+ - [UpdateBlogRequest](docs/UpdateBlogRequest.md)
70
+
71
+
72
+ <a id="documentation-for-authorization"></a>
73
+ ## Documentation For Authorization
74
+
75
+
76
+ Authentication schemes defined for the API:
77
+ <a id="api-key"></a>
78
+ ### api-key
79
+
80
+ - **Type**: API key
81
+ - **API key parameter name**: x-api-key
82
+ - **Location**: HTTP header
83
+
84
+ <a id="session-oauth"></a>
85
+ ### session-oauth
86
+
87
+ - **Type**: OAuth
88
+ - **Flow**: password
89
+ - **Authorization URL**:
90
+ - **Scopes**: N/A
91
+
package/api.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Blog API
5
5
  * Read and write blogs on the PodOS platform.
6
6
  *
7
- * The version of the OpenAPI document: 0.3.0
7
+ * The version of the OpenAPI document: 0.3.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/base.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Blog API
5
5
  * Read and write blogs on the PodOS platform.
6
6
  *
7
- * The version of the OpenAPI document: 0.3.0
7
+ * The version of the OpenAPI document: 0.3.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/common.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Blog API
5
5
  * Read and write blogs on the PodOS platform.
6
6
  *
7
- * The version of the OpenAPI document: 0.3.0
7
+ * The version of the OpenAPI document: 0.3.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/configuration.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Blog API
5
5
  * Read and write blogs on the PodOS platform.
6
6
  *
7
- * The version of the OpenAPI document: 0.3.0
7
+ * The version of the OpenAPI document: 0.3.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Blog API
3
3
  * Read and write blogs on the PodOS platform.
4
4
  *
5
- * The version of the OpenAPI document: 0.3.0
5
+ * The version of the OpenAPI document: 0.3.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/api.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Blog API
6
6
  * Read and write blogs on the PodOS platform.
7
7
  *
8
- * The version of the OpenAPI document: 0.3.0
8
+ * The version of the OpenAPI document: 0.3.1
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/base.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Blog API
3
3
  * Read and write blogs on the PodOS platform.
4
4
  *
5
- * The version of the OpenAPI document: 0.3.0
5
+ * The version of the OpenAPI document: 0.3.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/base.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Blog API
6
6
  * Read and write blogs on the PodOS platform.
7
7
  *
8
- * The version of the OpenAPI document: 0.3.0
8
+ * The version of the OpenAPI document: 0.3.1
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Blog API
3
3
  * Read and write blogs on the PodOS platform.
4
4
  *
5
- * The version of the OpenAPI document: 0.3.0
5
+ * The version of the OpenAPI document: 0.3.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Blog API
6
6
  * Read and write blogs on the PodOS platform.
7
7
  *
8
- * The version of the OpenAPI document: 0.3.0
8
+ * The version of the OpenAPI document: 0.3.1
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Blog API
3
3
  * Read and write blogs on the PodOS platform.
4
4
  *
5
- * The version of the OpenAPI document: 0.3.0
5
+ * The version of the OpenAPI document: 0.3.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -5,7 +5,7 @@
5
5
  * Blog API
6
6
  * Read and write blogs on the PodOS platform.
7
7
  *
8
- * The version of the OpenAPI document: 0.3.0
8
+ * The version of the OpenAPI document: 0.3.1
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Blog API
3
3
  * Read and write blogs on the PodOS platform.
4
4
  *
5
- * The version of the OpenAPI document: 0.3.0
5
+ * The version of the OpenAPI document: 0.3.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/api.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Blog API
5
5
  * Read and write blogs on the PodOS platform.
6
6
  *
7
- * The version of the OpenAPI document: 0.3.0
7
+ * The version of the OpenAPI document: 0.3.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Blog API
3
3
  * Read and write blogs on the PodOS platform.
4
4
  *
5
- * The version of the OpenAPI document: 0.3.0
5
+ * The version of the OpenAPI document: 0.3.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/base.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Blog API
5
5
  * Read and write blogs on the PodOS platform.
6
6
  *
7
- * The version of the OpenAPI document: 0.3.0
7
+ * The version of the OpenAPI document: 0.3.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Blog API
3
3
  * Read and write blogs on the PodOS platform.
4
4
  *
5
- * The version of the OpenAPI document: 0.3.0
5
+ * The version of the OpenAPI document: 0.3.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Blog API
5
5
  * Read and write blogs on the PodOS platform.
6
6
  *
7
- * The version of the OpenAPI document: 0.3.0
7
+ * The version of the OpenAPI document: 0.3.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Blog API
3
3
  * Read and write blogs on the PodOS platform.
4
4
  *
5
- * The version of the OpenAPI document: 0.3.0
5
+ * The version of the OpenAPI document: 0.3.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Blog API
5
5
  * Read and write blogs on the PodOS platform.
6
6
  *
7
- * The version of the OpenAPI document: 0.3.0
7
+ * The version of the OpenAPI document: 0.3.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Blog API
3
3
  * Read and write blogs on the PodOS platform.
4
4
  *
5
- * The version of the OpenAPI document: 0.3.0
5
+ * The version of the OpenAPI document: 0.3.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/index.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Blog API
5
5
  * Read and write blogs on the PodOS platform.
6
6
  *
7
- * The version of the OpenAPI document: 0.3.0
7
+ * The version of the OpenAPI document: 0.3.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Blog API
3
3
  * Read and write blogs on the PodOS platform.
4
4
  *
5
- * The version of the OpenAPI document: 0.3.0
5
+ * The version of the OpenAPI document: 0.3.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Blog API
6
6
  * Read and write blogs on the PodOS platform.
7
7
  *
8
- * The version of the OpenAPI document: 0.3.0
8
+ * The version of the OpenAPI document: 0.3.1
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -0,0 +1,22 @@
1
+ # ApiError
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **code** | **string** | | [optional] [default to undefined]
9
+ **message** | **string** | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { ApiError } from '@teemill/blog';
15
+
16
+ const instance: ApiError = {
17
+ code,
18
+ message,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/Blog.md ADDED
@@ -0,0 +1,40 @@
1
+ # Blog
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [default to undefined]
9
+ **title** | **string** | | [default to undefined]
10
+ **slug** | **string** | | [default to undefined]
11
+ **description** | **string** | | [default to undefined]
12
+ **tags** | **Array&lt;string&gt;** | | [optional] [default to undefined]
13
+ **metaImage** | **string** | | [default to undefined]
14
+ **type** | [**BlogListingType**](BlogListingType.md) | | [default to undefined]
15
+ **publishedAt** | **string** | | [default to undefined]
16
+ **createdAt** | **string** | | [default to undefined]
17
+ **updatedAt** | **string** | | [default to undefined]
18
+ **content** | **string** | | [default to undefined]
19
+
20
+ ## Example
21
+
22
+ ```typescript
23
+ import { Blog } from '@teemill/blog';
24
+
25
+ const instance: Blog = {
26
+ id,
27
+ title,
28
+ slug,
29
+ description,
30
+ tags,
31
+ metaImage,
32
+ type,
33
+ publishedAt,
34
+ createdAt,
35
+ updatedAt,
36
+ content,
37
+ };
38
+ ```
39
+
40
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,313 @@
1
+ # BlogApi
2
+
3
+ All URIs are relative to *https://localhost:8080*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**createBlog**](#createblog) | **POST** /v1/blog/blogs | Create a blog|
8
+ |[**deleteBlog**](#deleteblog) | **DELETE** /v1/blog/blogs/{blogId} | Delete a blog|
9
+ |[**getBlog**](#getblog) | **GET** /v1/blog/blogs/{blogId} | Get a blog|
10
+ |[**listBlogs**](#listblogs) | **GET** /v1/blog/blogs | List blogs|
11
+ |[**updateBlog**](#updateblog) | **PATCH** /v1/blog/blogs/{blogId} | Update a blog|
12
+
13
+ # **createBlog**
14
+ > Blog createBlog(createBlogRequest)
15
+
16
+
17
+ ### Example
18
+
19
+ ```typescript
20
+ import {
21
+ BlogApi,
22
+ Configuration,
23
+ CreateBlogRequest
24
+ } from '@teemill/blog';
25
+
26
+ const configuration = new Configuration();
27
+ const apiInstance = new BlogApi(configuration);
28
+
29
+ let project: string; // (default to undefined)
30
+ let createBlogRequest: CreateBlogRequest; //
31
+
32
+ const { status, data } = await apiInstance.createBlog(
33
+ project,
34
+ createBlogRequest
35
+ );
36
+ ```
37
+
38
+ ### Parameters
39
+
40
+ |Name | Type | Description | Notes|
41
+ |------------- | ------------- | ------------- | -------------|
42
+ | **createBlogRequest** | **CreateBlogRequest**| | |
43
+ | **project** | [**string**] | | defaults to undefined|
44
+
45
+
46
+ ### Return type
47
+
48
+ **Blog**
49
+
50
+ ### Authorization
51
+
52
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
53
+
54
+ ### HTTP request headers
55
+
56
+ - **Content-Type**: application/json
57
+ - **Accept**: application/json
58
+
59
+
60
+ ### HTTP response details
61
+ | Status code | Description | Response headers |
62
+ |-------------|-------------|------------------|
63
+ |**201** | A blog | - |
64
+ |**400** | Failed validation | - |
65
+ |**401** | Not authorised to access this resource | - |
66
+ |**403** | Refuse to authorize | - |
67
+ |**404** | Resource not found | - |
68
+ |**500** | Unknown server error | - |
69
+
70
+ [[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)
71
+
72
+ # **deleteBlog**
73
+ > deleteBlog()
74
+
75
+
76
+ ### Example
77
+
78
+ ```typescript
79
+ import {
80
+ BlogApi,
81
+ Configuration
82
+ } from '@teemill/blog';
83
+
84
+ const configuration = new Configuration();
85
+ const apiInstance = new BlogApi(configuration);
86
+
87
+ let project: string; // (default to undefined)
88
+ let blogId: string; // (default to undefined)
89
+
90
+ const { status, data } = await apiInstance.deleteBlog(
91
+ project,
92
+ blogId
93
+ );
94
+ ```
95
+
96
+ ### Parameters
97
+
98
+ |Name | Type | Description | Notes|
99
+ |------------- | ------------- | ------------- | -------------|
100
+ | **project** | [**string**] | | defaults to undefined|
101
+ | **blogId** | [**string**] | | defaults to undefined|
102
+
103
+
104
+ ### Return type
105
+
106
+ void (empty response body)
107
+
108
+ ### Authorization
109
+
110
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
111
+
112
+ ### HTTP request headers
113
+
114
+ - **Content-Type**: Not defined
115
+ - **Accept**: application/json
116
+
117
+
118
+ ### HTTP response details
119
+ | Status code | Description | Response headers |
120
+ |-------------|-------------|------------------|
121
+ |**204** | Blog deleted | - |
122
+ |**401** | Not authorised to access this resource | - |
123
+ |**403** | Refuse to authorize | - |
124
+ |**404** | Resource not found | - |
125
+ |**500** | Unknown server error | - |
126
+
127
+ [[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)
128
+
129
+ # **getBlog**
130
+ > Blog getBlog()
131
+
132
+
133
+ ### Example
134
+
135
+ ```typescript
136
+ import {
137
+ BlogApi,
138
+ Configuration
139
+ } from '@teemill/blog';
140
+
141
+ const configuration = new Configuration();
142
+ const apiInstance = new BlogApi(configuration);
143
+
144
+ let project: string; // (default to undefined)
145
+ let blogId: string; // (default to undefined)
146
+
147
+ const { status, data } = await apiInstance.getBlog(
148
+ project,
149
+ blogId
150
+ );
151
+ ```
152
+
153
+ ### Parameters
154
+
155
+ |Name | Type | Description | Notes|
156
+ |------------- | ------------- | ------------- | -------------|
157
+ | **project** | [**string**] | | defaults to undefined|
158
+ | **blogId** | [**string**] | | defaults to undefined|
159
+
160
+
161
+ ### Return type
162
+
163
+ **Blog**
164
+
165
+ ### Authorization
166
+
167
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
168
+
169
+ ### HTTP request headers
170
+
171
+ - **Content-Type**: Not defined
172
+ - **Accept**: application/json
173
+
174
+
175
+ ### HTTP response details
176
+ | Status code | Description | Response headers |
177
+ |-------------|-------------|------------------|
178
+ |**200** | A blog | - |
179
+ |**401** | Not authorised to access this resource | - |
180
+ |**403** | Refuse to authorize | - |
181
+ |**404** | Resource not found | - |
182
+ |**500** | Unknown server error | - |
183
+
184
+ [[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)
185
+
186
+ # **listBlogs**
187
+ > ListBlogsResponse listBlogs()
188
+
189
+
190
+ ### Example
191
+
192
+ ```typescript
193
+ import {
194
+ BlogApi,
195
+ Configuration
196
+ } from '@teemill/blog';
197
+
198
+ const configuration = new Configuration();
199
+ const apiInstance = new BlogApi(configuration);
200
+
201
+ let project: string; // (default to undefined)
202
+ let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
203
+ let pageToken: number; //Page reference token (optional) (default to 1)
204
+ let sortBy: Array<string>; //An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending. (optional) (default to undefined)
205
+ let search: string; //Search term to filter results (optional) (default to undefined)
206
+
207
+ const { status, data } = await apiInstance.listBlogs(
208
+ project,
209
+ pageSize,
210
+ pageToken,
211
+ sortBy,
212
+ search
213
+ );
214
+ ```
215
+
216
+ ### Parameters
217
+
218
+ |Name | Type | Description | Notes|
219
+ |------------- | ------------- | ------------- | -------------|
220
+ | **project** | [**string**] | | defaults to undefined|
221
+ | **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
222
+ | **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
223
+ | **sortBy** | **Array&lt;string&gt;** | An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending. | (optional) defaults to undefined|
224
+ | **search** | [**string**] | Search term to filter results | (optional) defaults to undefined|
225
+
226
+
227
+ ### Return type
228
+
229
+ **ListBlogsResponse**
230
+
231
+ ### Authorization
232
+
233
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
234
+
235
+ ### HTTP request headers
236
+
237
+ - **Content-Type**: Not defined
238
+ - **Accept**: application/json
239
+
240
+
241
+ ### HTTP response details
242
+ | Status code | Description | Response headers |
243
+ |-------------|-------------|------------------|
244
+ |**200** | A collection of blogs | - |
245
+ |**401** | Not authorised to access this resource | - |
246
+ |**403** | Refuse to authorize | - |
247
+ |**404** | Resource not found | - |
248
+ |**500** | Unknown server error | - |
249
+
250
+ [[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)
251
+
252
+ # **updateBlog**
253
+ > Blog updateBlog(updateBlogRequest)
254
+
255
+
256
+ ### Example
257
+
258
+ ```typescript
259
+ import {
260
+ BlogApi,
261
+ Configuration,
262
+ UpdateBlogRequest
263
+ } from '@teemill/blog';
264
+
265
+ const configuration = new Configuration();
266
+ const apiInstance = new BlogApi(configuration);
267
+
268
+ let project: string; // (default to undefined)
269
+ let blogId: string; // (default to undefined)
270
+ let updateBlogRequest: UpdateBlogRequest; //
271
+
272
+ const { status, data } = await apiInstance.updateBlog(
273
+ project,
274
+ blogId,
275
+ updateBlogRequest
276
+ );
277
+ ```
278
+
279
+ ### Parameters
280
+
281
+ |Name | Type | Description | Notes|
282
+ |------------- | ------------- | ------------- | -------------|
283
+ | **updateBlogRequest** | **UpdateBlogRequest**| | |
284
+ | **project** | [**string**] | | defaults to undefined|
285
+ | **blogId** | [**string**] | | defaults to undefined|
286
+
287
+
288
+ ### Return type
289
+
290
+ **Blog**
291
+
292
+ ### Authorization
293
+
294
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
295
+
296
+ ### HTTP request headers
297
+
298
+ - **Content-Type**: application/json
299
+ - **Accept**: application/json
300
+
301
+
302
+ ### HTTP response details
303
+ | Status code | Description | Response headers |
304
+ |-------------|-------------|------------------|
305
+ |**200** | A blog | - |
306
+ |**400** | Failed validation | - |
307
+ |**401** | Not authorised to access this resource | - |
308
+ |**403** | Refuse to authorize | - |
309
+ |**404** | Resource not found | - |
310
+ |**500** | Unknown server error | - |
311
+
312
+ [[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)
313
+
@@ -0,0 +1,38 @@
1
+ # BlogListing
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [default to undefined]
9
+ **title** | **string** | | [default to undefined]
10
+ **slug** | **string** | | [default to undefined]
11
+ **description** | **string** | | [default to undefined]
12
+ **tags** | **Array&lt;string&gt;** | | [optional] [default to undefined]
13
+ **metaImage** | **string** | | [default to undefined]
14
+ **type** | [**BlogListingType**](BlogListingType.md) | | [default to undefined]
15
+ **publishedAt** | **string** | | [default to undefined]
16
+ **createdAt** | **string** | | [default to undefined]
17
+ **updatedAt** | **string** | | [default to undefined]
18
+
19
+ ## Example
20
+
21
+ ```typescript
22
+ import { BlogListing } from '@teemill/blog';
23
+
24
+ const instance: BlogListing = {
25
+ id,
26
+ title,
27
+ slug,
28
+ description,
29
+ tags,
30
+ metaImage,
31
+ type,
32
+ publishedAt,
33
+ createdAt,
34
+ updatedAt,
35
+ };
36
+ ```
37
+
38
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,13 @@
1
+ # BlogListingType
2
+
3
+ The type of blog. Project blogs are only visible to the project. Platform blogs are visible to all clients of the platform. Requires the Platform module to be installed. Parent platform blogs are published by the parent platform of the current project.
4
+
5
+ ## Enum
6
+
7
+ * `Project` (value: `'project'`)
8
+
9
+ * `Platform` (value: `'platform'`)
10
+
11
+ * `ParentPlatform` (value: `'parent-platform'`)
12
+
13
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,34 @@
1
+ # CreateBlogRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **title** | **string** | | [default to undefined]
9
+ **content** | **string** | | [default to undefined]
10
+ **slug** | **string** | | [default to undefined]
11
+ **description** | **string** | | [default to undefined]
12
+ **tags** | **Array&lt;string&gt;** | | [optional] [default to undefined]
13
+ **metaImage** | **string** | | [default to undefined]
14
+ **published** | **boolean** | | [optional] [default to undefined]
15
+ **type** | **string** | The type of blog. Project blogs are only visible to the project. Platform blogs are visible to all clients of the project\&#39;s platform. Requires the Platform module to be installed. | [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { CreateBlogRequest } from '@teemill/blog';
21
+
22
+ const instance: CreateBlogRequest = {
23
+ title,
24
+ content,
25
+ slug,
26
+ description,
27
+ tags,
28
+ metaImage,
29
+ published,
30
+ type,
31
+ };
32
+ ```
33
+
34
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # ListBlogsResponse
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **blogs** | [**Array&lt;BlogListing&gt;**](BlogListing.md) | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { ListBlogsResponse } from '@teemill/blog';
14
+
15
+ const instance: ListBlogsResponse = {
16
+ blogs,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,32 @@
1
+ # UpdateBlogRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **title** | **string** | | [optional] [default to undefined]
9
+ **content** | **string** | | [optional] [default to undefined]
10
+ **slug** | **string** | | [optional] [default to undefined]
11
+ **description** | **string** | | [optional] [default to undefined]
12
+ **tags** | **Array&lt;string&gt;** | | [optional] [default to undefined]
13
+ **metaImage** | **string** | | [optional] [default to undefined]
14
+ **published** | **boolean** | | [optional] [default to undefined]
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import { UpdateBlogRequest } from '@teemill/blog';
20
+
21
+ const instance: UpdateBlogRequest = {
22
+ title,
23
+ content,
24
+ slug,
25
+ description,
26
+ tags,
27
+ metaImage,
28
+ published,
29
+ };
30
+ ```
31
+
32
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/index.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Blog API
5
5
  * Read and write blogs on the PodOS platform.
6
6
  *
7
- * The version of the OpenAPI document: 0.3.0
7
+ * The version of the OpenAPI document: 0.3.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@teemill/blog",
3
- "version": "0.3.0",
3
+ "version": "0.3.1",
4
4
  "description": "OpenAPI client for @teemill/blog",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {