|
| 1 | +# sysml_v2_api_client.CommitApi |
| 2 | + |
| 3 | +All URIs are relative to *http://localhost* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**get_commit_by_project_and_id**](CommitApi.md#get_commit_by_project_and_id) | **GET** /projects/{projectId}/commits/{commitId} | Get commit by project and ID |
| 8 | +[**get_commits_by_project**](CommitApi.md#get_commits_by_project) | **GET** /projects/{projectId}/commits | Get commits by project |
| 9 | +[**get_head_commit_by_project**](CommitApi.md#get_head_commit_by_project) | **GET** /projects/{projectId}/head | Get head commit by project |
| 10 | +[**post_commit_by_project**](CommitApi.md#post_commit_by_project) | **POST** /projects/{projectId}/commits | Create commit by project |
| 11 | + |
| 12 | + |
| 13 | +# **get_commit_by_project_and_id** |
| 14 | +> Commit get_commit_by_project_and_id(project_id, commit_id) |
| 15 | +
|
| 16 | +Get commit by project and ID |
| 17 | + |
| 18 | +### Example |
| 19 | + |
| 20 | +```python |
| 21 | +from __future__ import print_function |
| 22 | +import time |
| 23 | +import sysml_v2_api_client |
| 24 | +from sysml_v2_api_client.rest import ApiException |
| 25 | +from pprint import pprint |
| 26 | + |
| 27 | +# Enter a context with an instance of the API client |
| 28 | +with sysml_v2_api_client.ApiClient() as api_client: |
| 29 | + # Create an instance of the API class |
| 30 | + api_instance = sysml_v2_api_client.CommitApi(api_client) |
| 31 | + project_id = 'project_id_example' # str | ID of the project |
| 32 | +commit_id = 'commit_id_example' # str | ID of the commit |
| 33 | + |
| 34 | + try: |
| 35 | + # Get commit by project and ID |
| 36 | + api_response = api_instance.get_commit_by_project_and_id(project_id, commit_id) |
| 37 | + pprint(api_response) |
| 38 | + except ApiException as e: |
| 39 | + print("Exception when calling CommitApi->get_commit_by_project_and_id: %s\n" % e) |
| 40 | +``` |
| 41 | + |
| 42 | +### Parameters |
| 43 | + |
| 44 | +Name | Type | Description | Notes |
| 45 | +------------- | ------------- | ------------- | ------------- |
| 46 | + **project_id** | **str**| ID of the project | |
| 47 | + **commit_id** | **str**| ID of the commit | |
| 48 | + |
| 49 | +### Return type |
| 50 | + |
| 51 | +[**Commit**](Commit.md) |
| 52 | + |
| 53 | +### Authorization |
| 54 | + |
| 55 | +No authorization required |
| 56 | + |
| 57 | +### HTTP request headers |
| 58 | + |
| 59 | + - **Content-Type**: Not defined |
| 60 | + - **Accept**: application/json |
| 61 | + |
| 62 | +### HTTP response details |
| 63 | +| Status code | Description | Response headers | |
| 64 | +|-------------|-------------|------------------| |
| 65 | +**200** | Ok | - | |
| 66 | +**404** | Not found. | - | |
| 67 | +**415** | The requested content type is not acceptable. | - | |
| 68 | +**500** | Internal server error. | - | |
| 69 | +**0** | Unexpected response. | - | |
| 70 | + |
| 71 | +[[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) |
| 72 | + |
| 73 | +# **get_commits_by_project** |
| 74 | +> Commit get_commits_by_project(project_id) |
| 75 | +
|
| 76 | +Get commits by project |
| 77 | + |
| 78 | +### Example |
| 79 | + |
| 80 | +```python |
| 81 | +from __future__ import print_function |
| 82 | +import time |
| 83 | +import sysml_v2_api_client |
| 84 | +from sysml_v2_api_client.rest import ApiException |
| 85 | +from pprint import pprint |
| 86 | + |
| 87 | +# Enter a context with an instance of the API client |
| 88 | +with sysml_v2_api_client.ApiClient() as api_client: |
| 89 | + # Create an instance of the API class |
| 90 | + api_instance = sysml_v2_api_client.CommitApi(api_client) |
| 91 | + project_id = 'project_id_example' # str | ID of the project |
| 92 | + |
| 93 | + try: |
| 94 | + # Get commits by project |
| 95 | + api_response = api_instance.get_commits_by_project(project_id) |
| 96 | + pprint(api_response) |
| 97 | + except ApiException as e: |
| 98 | + print("Exception when calling CommitApi->get_commits_by_project: %s\n" % e) |
| 99 | +``` |
| 100 | + |
| 101 | +### Parameters |
| 102 | + |
| 103 | +Name | Type | Description | Notes |
| 104 | +------------- | ------------- | ------------- | ------------- |
| 105 | + **project_id** | [**str**](.md)| ID of the project | |
| 106 | + |
| 107 | +### Return type |
| 108 | + |
| 109 | +[**Commit**](Commit.md) |
| 110 | + |
| 111 | +### Authorization |
| 112 | + |
| 113 | +No authorization required |
| 114 | + |
| 115 | +### HTTP request headers |
| 116 | + |
| 117 | + - **Content-Type**: Not defined |
| 118 | + - **Accept**: application/json |
| 119 | + |
| 120 | +### HTTP response details |
| 121 | +| Status code | Description | Response headers | |
| 122 | +|-------------|-------------|------------------| |
| 123 | +**200** | Ok | - | |
| 124 | +**404** | Not found. | - | |
| 125 | +**415** | The requested content type is not acceptable. | - | |
| 126 | +**500** | Internal server error. | - | |
| 127 | +**0** | Unexpected response. | - | |
| 128 | + |
| 129 | +[[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) |
| 130 | + |
| 131 | +# **get_head_commit_by_project** |
| 132 | +> Commit get_head_commit_by_project(project_id) |
| 133 | +
|
| 134 | +Get head commit by project |
| 135 | + |
| 136 | +### Example |
| 137 | + |
| 138 | +```python |
| 139 | +from __future__ import print_function |
| 140 | +import time |
| 141 | +import sysml_v2_api_client |
| 142 | +from sysml_v2_api_client.rest import ApiException |
| 143 | +from pprint import pprint |
| 144 | + |
| 145 | +# Enter a context with an instance of the API client |
| 146 | +with sysml_v2_api_client.ApiClient() as api_client: |
| 147 | + # Create an instance of the API class |
| 148 | + api_instance = sysml_v2_api_client.CommitApi(api_client) |
| 149 | + project_id = 'project_id_example' # str | ID of the project |
| 150 | + |
| 151 | + try: |
| 152 | + # Get head commit by project |
| 153 | + api_response = api_instance.get_head_commit_by_project(project_id) |
| 154 | + pprint(api_response) |
| 155 | + except ApiException as e: |
| 156 | + print("Exception when calling CommitApi->get_head_commit_by_project: %s\n" % e) |
| 157 | +``` |
| 158 | + |
| 159 | +### Parameters |
| 160 | + |
| 161 | +Name | Type | Description | Notes |
| 162 | +------------- | ------------- | ------------- | ------------- |
| 163 | + **project_id** | **str**| ID of the project | |
| 164 | + |
| 165 | +### Return type |
| 166 | + |
| 167 | +[**Commit**](Commit.md) |
| 168 | + |
| 169 | +### Authorization |
| 170 | + |
| 171 | +No authorization required |
| 172 | + |
| 173 | +### HTTP request headers |
| 174 | + |
| 175 | + - **Content-Type**: Not defined |
| 176 | + - **Accept**: application/json |
| 177 | + |
| 178 | +### HTTP response details |
| 179 | +| Status code | Description | Response headers | |
| 180 | +|-------------|-------------|------------------| |
| 181 | +**200** | Ok | - | |
| 182 | +**404** | Not found. | - | |
| 183 | +**415** | The requested content type is not acceptable. | - | |
| 184 | +**500** | Internal server error. | - | |
| 185 | +**0** | Unexpected response. | - | |
| 186 | + |
| 187 | +[[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) |
| 188 | + |
| 189 | +# **post_commit_by_project** |
| 190 | +> Commit post_commit_by_project(project_id, body) |
| 191 | +
|
| 192 | +Create commit by project |
| 193 | + |
| 194 | +### Example |
| 195 | + |
| 196 | +```python |
| 197 | +from __future__ import print_function |
| 198 | +import time |
| 199 | +import sysml_v2_api_client |
| 200 | +from sysml_v2_api_client.rest import ApiException |
| 201 | +from pprint import pprint |
| 202 | + |
| 203 | +# Enter a context with an instance of the API client |
| 204 | +with sysml_v2_api_client.ApiClient() as api_client: |
| 205 | + # Create an instance of the API class |
| 206 | + api_instance = sysml_v2_api_client.CommitApi(api_client) |
| 207 | + project_id = 'project_id_example' # str | ID of the project |
| 208 | +body = sysml_v2_api_client.Commit() # Commit | |
| 209 | + |
| 210 | + try: |
| 211 | + # Create commit by project |
| 212 | + api_response = api_instance.post_commit_by_project(project_id, body) |
| 213 | + pprint(api_response) |
| 214 | + except ApiException as e: |
| 215 | + print("Exception when calling CommitApi->post_commit_by_project: %s\n" % e) |
| 216 | +``` |
| 217 | + |
| 218 | +### Parameters |
| 219 | + |
| 220 | +Name | Type | Description | Notes |
| 221 | +------------- | ------------- | ------------- | ------------- |
| 222 | + **project_id** | [**str**](.md)| ID of the project | |
| 223 | + **body** | [**Commit**](Commit.md)| | |
| 224 | + |
| 225 | +### Return type |
| 226 | + |
| 227 | +[**Commit**](Commit.md) |
| 228 | + |
| 229 | +### Authorization |
| 230 | + |
| 231 | +No authorization required |
| 232 | + |
| 233 | +### HTTP request headers |
| 234 | + |
| 235 | + - **Content-Type**: application/json |
| 236 | + - **Accept**: application/json |
| 237 | + |
| 238 | +### HTTP response details |
| 239 | +| Status code | Description | Response headers | |
| 240 | +|-------------|-------------|------------------| |
| 241 | +**201** | Created | - | |
| 242 | +**415** | The requested content type is not acceptable. | - | |
| 243 | +**500** | Internal server error. | - | |
| 244 | +**0** | Unexpected response. | - | |
| 245 | + |
| 246 | +[[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) |
| 247 | + |
0 commit comments