openapi-github 0.1.0

OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286

# \InteractionsApi

All URIs are relative to *https://api.github.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**interactions_slash_get_restrictions_for_authenticated_user**](InteractionsApi.md#interactions_slash_get_restrictions_for_authenticated_user) | **GET** /user/interaction-limits | Get interaction restrictions for your public repositories
[**interactions_slash_get_restrictions_for_org**](InteractionsApi.md#interactions_slash_get_restrictions_for_org) | **GET** /orgs/{org}/interaction-limits | Get interaction restrictions for an organization
[**interactions_slash_get_restrictions_for_repo**](InteractionsApi.md#interactions_slash_get_restrictions_for_repo) | **GET** /repos/{owner}/{repo}/interaction-limits | Get interaction restrictions for a repository
[**interactions_slash_remove_restrictions_for_authenticated_user**](InteractionsApi.md#interactions_slash_remove_restrictions_for_authenticated_user) | **DELETE** /user/interaction-limits | Remove interaction restrictions from your public repositories
[**interactions_slash_remove_restrictions_for_org**](InteractionsApi.md#interactions_slash_remove_restrictions_for_org) | **DELETE** /orgs/{org}/interaction-limits | Remove interaction restrictions for an organization
[**interactions_slash_remove_restrictions_for_repo**](InteractionsApi.md#interactions_slash_remove_restrictions_for_repo) | **DELETE** /repos/{owner}/{repo}/interaction-limits | Remove interaction restrictions for a repository
[**interactions_slash_set_restrictions_for_authenticated_user**](InteractionsApi.md#interactions_slash_set_restrictions_for_authenticated_user) | **PUT** /user/interaction-limits | Set interaction restrictions for your public repositories
[**interactions_slash_set_restrictions_for_org**](InteractionsApi.md#interactions_slash_set_restrictions_for_org) | **PUT** /orgs/{org}/interaction-limits | Set interaction restrictions for an organization
[**interactions_slash_set_restrictions_for_repo**](InteractionsApi.md#interactions_slash_set_restrictions_for_repo) | **PUT** /repos/{owner}/{repo}/interaction-limits | Set interaction restrictions for a repository



## interactions_slash_get_restrictions_for_authenticated_user

> models::InteractionsGetRestrictionsForOrg200Response interactions_slash_get_restrictions_for_authenticated_user()
Get interaction restrictions for your public repositories

Shows which type of GitHub user can interact with your public repositories and when the restriction expires.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::InteractionsGetRestrictionsForOrg200Response**](interactions_get_restrictions_for_org_200_response.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)


## interactions_slash_get_restrictions_for_org

> models::InteractionsGetRestrictionsForOrg200Response interactions_slash_get_restrictions_for_org(org)
Get interaction restrictions for an organization

Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**org** | **String** | The organization name. The name is not case sensitive. | [required] |

### Return type

[**models::InteractionsGetRestrictionsForOrg200Response**](interactions_get_restrictions_for_org_200_response.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)


## interactions_slash_get_restrictions_for_repo

> models::InteractionsGetRestrictionsForOrg200Response interactions_slash_get_restrictions_for_repo(owner, repo)
Get interaction restrictions for a repository

Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**owner** | **String** | The account owner of the repository. The name is not case sensitive. | [required] |
**repo** | **String** | The name of the repository without the `.git` extension. The name is not case sensitive. | [required] |

### Return type

[**models::InteractionsGetRestrictionsForOrg200Response**](interactions_get_restrictions_for_org_200_response.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)


## interactions_slash_remove_restrictions_for_authenticated_user

> interactions_slash_remove_restrictions_for_authenticated_user()
Remove interaction restrictions from your public repositories

Removes any interaction restrictions from your public repositories.

### Parameters

This endpoint does not need any parameter.

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[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)


## interactions_slash_remove_restrictions_for_org

> interactions_slash_remove_restrictions_for_org(org)
Remove interaction restrictions for an organization

Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**org** | **String** | The organization name. The name is not case sensitive. | [required] |

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[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)


## interactions_slash_remove_restrictions_for_repo

> interactions_slash_remove_restrictions_for_repo(owner, repo)
Remove interaction restrictions for a repository

Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**owner** | **String** | The account owner of the repository. The name is not case sensitive. | [required] |
**repo** | **String** | The name of the repository without the `.git` extension. The name is not case sensitive. | [required] |

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[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)


## interactions_slash_set_restrictions_for_authenticated_user

> models::InteractionLimitResponse interactions_slash_set_restrictions_for_authenticated_user(interaction_limit)
Set interaction restrictions for your public repositories

Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**interaction_limit** | [**InteractionLimit**](InteractionLimit.md) |  | [required] |

### Return type

[**models::InteractionLimitResponse**](interaction-limit-response.md)

### Authorization

No authorization required

### 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)


## interactions_slash_set_restrictions_for_org

> models::InteractionLimitResponse interactions_slash_set_restrictions_for_org(org, interaction_limit)
Set interaction restrictions for an organization

Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**org** | **String** | The organization name. The name is not case sensitive. | [required] |
**interaction_limit** | [**InteractionLimit**](InteractionLimit.md) |  | [required] |

### Return type

[**models::InteractionLimitResponse**](interaction-limit-response.md)

### Authorization

No authorization required

### 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)


## interactions_slash_set_restrictions_for_repo

> models::InteractionLimitResponse interactions_slash_set_restrictions_for_repo(owner, repo, interaction_limit)
Set interaction restrictions for a repository

Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**owner** | **String** | The account owner of the repository. The name is not case sensitive. | [required] |
**repo** | **String** | The name of the repository without the `.git` extension. The name is not case sensitive. | [required] |
**interaction_limit** | [**InteractionLimit**](InteractionLimit.md) |  | [required] |

### Return type

[**models::InteractionLimitResponse**](interaction-limit-response.md)

### Authorization

No authorization required

### 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)