Skip to content

Commit 5bbb86d

Browse files
authored
Merge pull request #53 from ityuhui/yh-auto-generate-doc
[DOCUMENT] Add API and model documents
2 parents ea540c9 + 6381367 commit 5bbb86d

File tree

744 files changed

+45250
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

744 files changed

+45250
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,10 @@ If the C client library is used in multi-threaded program, the following 2 actio
138138

139139
Refer to the [example](https://github.com/kubernetes-client/c/tree/master/examples/multi_thread/) for detail.
140140

141+
## Documentation
142+
143+
All APIs and Models' documentation can be found at the [Generated client's README file](https://github.com/kubernetes-client/c/blob/master/kubernetes/README.md#documentation-for-api-endpoints)
144+
141145
## Community, discussion, contribution, and support
142146

143147
Learn how to engage with the Kubernetes community on the [community page](http://kubernetes.io/community/).

kubernetes/README.md

Lines changed: 1660 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# AdmissionregistrationAPI
2+
3+
All URIs are relative to *http://localhost*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**AdmissionregistrationAPI_getAPIGroup**](AdmissionregistrationAPI.md#AdmissionregistrationAPI_getAPIGroup) | **GET** /apis/admissionregistration.k8s.io/ |
8+
9+
10+
# **AdmissionregistrationAPI_getAPIGroup**
11+
```c
12+
// get information of a group
13+
//
14+
v1_api_group_t* AdmissionregistrationAPI_getAPIGroup(apiClient_t *apiClient);
15+
```
16+
17+
### Parameters
18+
Name | Type | Description | Notes
19+
------------- | ------------- | ------------- | -------------
20+
**apiClient** | **apiClient_t \*** | context containing the client configuration |
21+
22+
### Return type
23+
24+
[v1_api_group_t](v1_api_group.md) *
25+
26+
27+
### Authorization
28+
29+
[BearerToken](../README.md#BearerToken)
30+
31+
### HTTP request headers
32+
33+
- **Content-Type**: Not defined
34+
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
35+
36+
[[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)
37+

kubernetes/docs/AdmissionregistrationV1API.md

Lines changed: 537 additions & 0 deletions
Large diffs are not rendered by default.

kubernetes/docs/AdmissionregistrationV1beta1API.md

Lines changed: 537 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# ApiextensionsAPI
2+
3+
All URIs are relative to *http://localhost*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**ApiextensionsAPI_getAPIGroup**](ApiextensionsAPI.md#ApiextensionsAPI_getAPIGroup) | **GET** /apis/apiextensions.k8s.io/ |
8+
9+
10+
# **ApiextensionsAPI_getAPIGroup**
11+
```c
12+
// get information of a group
13+
//
14+
v1_api_group_t* ApiextensionsAPI_getAPIGroup(apiClient_t *apiClient);
15+
```
16+
17+
### Parameters
18+
Name | Type | Description | Notes
19+
------------- | ------------- | ------------- | -------------
20+
**apiClient** | **apiClient_t \*** | context containing the client configuration |
21+
22+
### Return type
23+
24+
[v1_api_group_t](v1_api_group.md) *
25+
26+
27+
### Authorization
28+
29+
[BearerToken](../README.md#BearerToken)
30+
31+
### HTTP request headers
32+
33+
- **Content-Type**: Not defined
34+
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
35+
36+
[[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)
37+

kubernetes/docs/ApiextensionsV1API.md

Lines changed: 387 additions & 0 deletions
Large diffs are not rendered by default.

kubernetes/docs/ApiextensionsV1beta1API.md

Lines changed: 387 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# ApiregistrationAPI
2+
3+
All URIs are relative to *http://localhost*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**ApiregistrationAPI_getAPIGroup**](ApiregistrationAPI.md#ApiregistrationAPI_getAPIGroup) | **GET** /apis/apiregistration.k8s.io/ |
8+
9+
10+
# **ApiregistrationAPI_getAPIGroup**
11+
```c
12+
// get information of a group
13+
//
14+
v1_api_group_t* ApiregistrationAPI_getAPIGroup(apiClient_t *apiClient);
15+
```
16+
17+
### Parameters
18+
Name | Type | Description | Notes
19+
------------- | ------------- | ------------- | -------------
20+
**apiClient** | **apiClient_t \*** | context containing the client configuration |
21+
22+
### Return type
23+
24+
[v1_api_group_t](v1_api_group.md) *
25+
26+
27+
### Authorization
28+
29+
[BearerToken](../README.md#BearerToken)
30+
31+
### HTTP request headers
32+
33+
- **Content-Type**: Not defined
34+
- **Accept**: application/json, application/yaml, application/vnd.kubernetes.protobuf
35+
36+
[[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)
37+

kubernetes/docs/ApiregistrationV1API.md

Lines changed: 387 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)