forem_openapi_client 1.0.0

Access Forem articles, users and other resources via API. For a real-world example of Forem in action, check out [DEV](https://www.dev.to). All endpoints can be accessed with the 'api-key' header and a accept header, but some of them are accessible publicly without authentication. Dates and date times, unless otherwise specified, must be in the [RFC 3339](https://tools.ietf.org/html/rfc3339) format. Generated at 2023-04-10T05:06:38.929104+00:00
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161

# \PagesApi

All URIs are relative to *https://dev.to/api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**api_pages_get**](PagesApi.md#api_pages_get) | **GET** /api/pages | show details for all pages
[**api_pages_id_delete**](PagesApi.md#api_pages_id_delete) | **DELETE** /api/pages/{id} | remove a page
[**api_pages_id_get**](PagesApi.md#api_pages_id_get) | **GET** /api/pages/{id} | show details for a page
[**api_pages_id_put**](PagesApi.md#api_pages_id_put) | **PUT** /api/pages/{id} | update details for a page
[**api_pages_post**](PagesApi.md#api_pages_post) | **POST** /api/pages | pages



## api_pages_get

> Vec<crate::models::Page> api_pages_get()
show details for all pages

This endpoint allows the client to retrieve details for all Page objects.

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<crate::models::Page>**](Page.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/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)


## api_pages_id_delete

> crate::models::Page api_pages_id_delete(id)
remove a page

This endpoint allows the client to delete a single Page object, specified by ID.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **i32** | The ID of the page. | [required] |

### Return type

[**crate::models::Page**](Page.md)

### Authorization

[api-key](../README.md#api-key)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/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)


## api_pages_id_get

> crate::models::Page api_pages_id_get(id)
show details for a page

This endpoint allows the client to retrieve details for a single Page object, specified by ID.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **i32** | The ID of the page. | [required] |

### Return type

[**crate::models::Page**](Page.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/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)


## api_pages_id_put

> crate::models::Page api_pages_id_put(id, page)
update details for a page

This endpoint allows the client to retrieve details for a single Page object, specified by ID.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **i32** | The ID of the page. | [required] |
**page** | Option<[**Page**](Page.md)> |  |  |

### Return type

[**crate::models::Page**](Page.md)

### Authorization

[api-key](../README.md#api-key)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/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)


## api_pages_post

> api_pages_post(api_pages_post_request)
pages

This endpoint allows the client to create a new page.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**api_pages_post_request** | Option<[**ApiPagesPostRequest**](ApiPagesPostRequest.md)> |  |  |

### Return type

 (empty response body)

### Authorization

[api-key](../README.md#api-key)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/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)