-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
28 changed files
with
1,095 additions
and
283 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # Branch | ||
|
|
||
| ## Properties | ||
| Name | Type | Description | Notes | ||
| ------------ | ------------- | ------------- | ------------- | ||
| **type** | **str** | | [optional] | ||
| **head** | [**BranchHead**](BranchHead.md) | | [optional] | ||
| **owning_project** | [**BranchOwningProject**](BranchOwningProject.md) | | [optional] | ||
| **id** | **str** | | [optional] | ||
| **name** | **str** | | [optional] | ||
|
|
||
| [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,212 @@ | ||
| # sysml_v2_api_client.BranchApi | ||
|
|
||
| All URIs are relative to *http://localhost* | ||
|
|
||
| Method | HTTP request | Description | ||
| ------------- | ------------- | ------------- | ||
| [**get_branches_by_project**](BranchApi.md#get_branches_by_project) | **GET** /projects/{projectId}/branches | Get branches by project | ||
| [**get_branches_by_project_and_id**](BranchApi.md#get_branches_by_project_and_id) | **GET** /projects/{projectId}/branches/{branchId} | Get branch by project and ID | ||
| [**post_branch_by_project**](BranchApi.md#post_branch_by_project) | **POST** /projects/{projectId}/branches | Create branch by project | ||
|
|
||
|
|
||
| # **get_branches_by_project** | ||
| > list[Branch] get_branches_by_project(project_id, page_after=page_after, page_before=page_before, page_size=page_size) | ||
| Get branches by project | ||
|
|
||
| ### Example | ||
|
|
||
| ```python | ||
| from __future__ import print_function | ||
| import time | ||
| import sysml_v2_api_client | ||
| from sysml_v2_api_client.rest import ApiException | ||
| from pprint import pprint | ||
| # Defining the host is optional and defaults to http://localhost | ||
| # See configuration.py for a list of all supported configuration parameters. | ||
| configuration = sysml_v2_api_client.Configuration( | ||
| host = "http://localhost" | ||
| ) | ||
|
|
||
|
|
||
| # Enter a context with an instance of the API client | ||
| with sysml_v2_api_client.ApiClient() as api_client: | ||
| # Create an instance of the API class | ||
| api_instance = sysml_v2_api_client.BranchApi(api_client) | ||
| project_id = 'project_id_example' # str | ID of the project | ||
| page_after = 'page_after_example' # str | Page after (optional) | ||
| page_before = 'page_before_example' # str | Page before (optional) | ||
| page_size = 56 # int | Page size (optional) | ||
|
|
||
| try: | ||
| # Get branches by project | ||
| api_response = api_instance.get_branches_by_project(project_id, page_after=page_after, page_before=page_before, page_size=page_size) | ||
| pprint(api_response) | ||
| except ApiException as e: | ||
| print("Exception when calling BranchApi->get_branches_by_project: %s\n" % e) | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **project_id** | [**str**](.md)| ID of the project | | ||
| **page_after** | **str**| Page after | [optional] | ||
| **page_before** | **str**| Page before | [optional] | ||
| **page_size** | **int**| Page size | [optional] | ||
|
|
||
| ### Return type | ||
|
|
||
| [**list[Branch]**](Branch.md) | ||
|
|
||
| ### Authorization | ||
|
|
||
| No authorization required | ||
|
|
||
| ### HTTP request headers | ||
|
|
||
| - **Content-Type**: Not defined | ||
| - **Accept**: application/json | ||
|
|
||
| ### HTTP response details | ||
| | Status code | Description | Response headers | | ||
| |-------------|-------------|------------------| | ||
| **200** | Ok | - | | ||
| **404** | Not found. | - | | ||
| **415** | The requested content type is not acceptable. | - | | ||
| **500** | Internal server error. | - | | ||
| **0** | Unexpected response. | - | | ||
|
|
||
| [[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) | ||
|
|
||
| # **get_branches_by_project_and_id** | ||
| > Branch get_branches_by_project_and_id(project_id, branch_id) | ||
| Get branch by project and ID | ||
|
|
||
| ### Example | ||
|
|
||
| ```python | ||
| from __future__ import print_function | ||
| import time | ||
| import sysml_v2_api_client | ||
| from sysml_v2_api_client.rest import ApiException | ||
| from pprint import pprint | ||
| # Defining the host is optional and defaults to http://localhost | ||
| # See configuration.py for a list of all supported configuration parameters. | ||
| configuration = sysml_v2_api_client.Configuration( | ||
| host = "http://localhost" | ||
| ) | ||
|
|
||
|
|
||
| # Enter a context with an instance of the API client | ||
| with sysml_v2_api_client.ApiClient() as api_client: | ||
| # Create an instance of the API class | ||
| api_instance = sysml_v2_api_client.BranchApi(api_client) | ||
| project_id = 'project_id_example' # str | ID of the project | ||
| branch_id = 'branch_id_example' # str | ID of the branch | ||
|
|
||
| try: | ||
| # Get branch by project and ID | ||
| api_response = api_instance.get_branches_by_project_and_id(project_id, branch_id) | ||
| pprint(api_response) | ||
| except ApiException as e: | ||
| print("Exception when calling BranchApi->get_branches_by_project_and_id: %s\n" % e) | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **project_id** | [**str**](.md)| ID of the project | | ||
| **branch_id** | [**str**](.md)| ID of the branch | | ||
|
|
||
| ### Return type | ||
|
|
||
| [**Branch**](Branch.md) | ||
|
|
||
| ### Authorization | ||
|
|
||
| No authorization required | ||
|
|
||
| ### HTTP request headers | ||
|
|
||
| - **Content-Type**: Not defined | ||
| - **Accept**: application/json | ||
|
|
||
| ### HTTP response details | ||
| | Status code | Description | Response headers | | ||
| |-------------|-------------|------------------| | ||
| **200** | Ok | - | | ||
| **404** | Not found. | - | | ||
| **415** | The requested content type is not acceptable. | - | | ||
| **500** | Internal server error. | - | | ||
| **0** | Unexpected response. | - | | ||
|
|
||
| [[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) | ||
|
|
||
| # **post_branch_by_project** | ||
| > Branch post_branch_by_project(project_id, body) | ||
| Create branch by project | ||
|
|
||
| ### Example | ||
|
|
||
| ```python | ||
| from __future__ import print_function | ||
| import time | ||
| import sysml_v2_api_client | ||
| from sysml_v2_api_client.rest import ApiException | ||
| from pprint import pprint | ||
| # Defining the host is optional and defaults to http://localhost | ||
| # See configuration.py for a list of all supported configuration parameters. | ||
| configuration = sysml_v2_api_client.Configuration( | ||
| host = "http://localhost" | ||
| ) | ||
|
|
||
|
|
||
| # Enter a context with an instance of the API client | ||
| with sysml_v2_api_client.ApiClient() as api_client: | ||
| # Create an instance of the API class | ||
| api_instance = sysml_v2_api_client.BranchApi(api_client) | ||
| project_id = 'project_id_example' # str | ID of the project | ||
| body = sysml_v2_api_client.Branch() # Branch | | ||
|
|
||
| try: | ||
| # Create branch by project | ||
| api_response = api_instance.post_branch_by_project(project_id, body) | ||
| pprint(api_response) | ||
| except ApiException as e: | ||
| print("Exception when calling BranchApi->post_branch_by_project: %s\n" % e) | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **project_id** | [**str**](.md)| ID of the project | | ||
| **body** | [**Branch**](Branch.md)| | | ||
|
|
||
| ### Return type | ||
|
|
||
| [**Branch**](Branch.md) | ||
|
|
||
| ### Authorization | ||
|
|
||
| No authorization required | ||
|
|
||
| ### HTTP request headers | ||
|
|
||
| - **Content-Type**: application/json | ||
| - **Accept**: application/json | ||
|
|
||
| ### HTTP response details | ||
| | Status code | Description | Response headers | | ||
| |-------------|-------------|------------------| | ||
| **201** | Created | - | | ||
| **415** | The requested content type is not acceptable. | - | | ||
| **500** | Internal server error. | - | | ||
| **0** | Unexpected response. | - | | ||
|
|
||
| [[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) | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.