Skip to content

Commit f9e0c69

Browse files
ivan-gomesivan-gomes
committed
Merge branch 'release/2021-04'
2 parents c9bcc2e + 6c19889 commit f9e0c69

28 files changed

+1095
-283
lines changed

‎README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ REST/HTTP binding (PSM) for the SysML v2 standard API.
44
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
55

66
- API version: 1.0.0
7-
- Package version: 2021-03
7+
- Package version: 2021-04
88
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
99

1010
## Requirements.
@@ -63,16 +63,18 @@ configuration = sysml_v2_api_client.Configuration(
6363
# Enter a context with an instance of the API client
6464
with sysml_v2_api_client.ApiClient(configuration) as api_client:
6565
# Create an instance of the API class
66-
api_instance = sysml_v2_api_client.CommitApi(api_client)
66+
api_instance = sysml_v2_api_client.BranchApi(api_client)
6767
project_id = 'project_id_example' # str | ID of the project
68-
commit_id = 'commit_id_example' # str | ID of the commit
68+
page_after = 'page_after_example' # str | Page after (optional)
69+
page_before = 'page_before_example' # str | Page before (optional)
70+
page_size = 56 # int | Page size (optional)
6971

7072
try:
71-
# Get commit by project and ID
72-
api_response = api_instance.get_commit_by_project_and_id(project_id, commit_id)
73+
# Get branches by project
74+
api_response = api_instance.get_branches_by_project(project_id, page_after=page_after, page_before=page_before, page_size=page_size)
7375
pprint(api_response)
7476
except ApiException as e:
75-
print("Exception when calling CommitApi->get_commit_by_project_and_id: %s\n" % e)
77+
print("Exception when calling BranchApi->get_branches_by_project: %s\n" % e)
7678

7779
```
7880

@@ -82,9 +84,11 @@ All URIs are relative to *http://localhost*
8284

8385
Class | Method | HTTP request | Description
8486
------------ | ------------- | ------------- | -------------
87+
*BranchApi* | [**get_branches_by_project**](docs/BranchApi.md#get_branches_by_project) | **GET** /projects/{projectId}/branches | Get branches by project
88+
*BranchApi* | [**get_branches_by_project_and_id**](docs/BranchApi.md#get_branches_by_project_and_id) | **GET** /projects/{projectId}/branches/{branchId} | Get branch by project and ID
89+
*BranchApi* | [**post_branch_by_project**](docs/BranchApi.md#post_branch_by_project) | **POST** /projects/{projectId}/branches | Create branch by project
8590
*CommitApi* | [**get_commit_by_project_and_id**](docs/CommitApi.md#get_commit_by_project_and_id) | **GET** /projects/{projectId}/commits/{commitId} | Get commit by project and ID
8691
*CommitApi* | [**get_commits_by_project**](docs/CommitApi.md#get_commits_by_project) | **GET** /projects/{projectId}/commits | Get commits by project
87-
*CommitApi* | [**get_head_commit_by_project**](docs/CommitApi.md#get_head_commit_by_project) | **GET** /projects/{projectId}/head | Get head commit by project
8892
*CommitApi* | [**post_commit_by_project**](docs/CommitApi.md#post_commit_by_project) | **POST** /projects/{projectId}/commits | Create commit by project
8993
*ElementApi* | [**get_element_by_project_commit_id**](docs/ElementApi.md#get_element_by_project_commit_id) | **GET** /projects/{projectId}/commits/{commitId}/elements/{elementId} | Get element by project, commit and ID
9094
*ElementApi* | [**get_elements_by_project_commit**](docs/ElementApi.md#get_elements_by_project_commit) | **GET** /projects/{projectId}/commits/{commitId}/elements | Get elements by project and commit
@@ -103,8 +107,10 @@ Class | Method | HTTP request | Description
103107

104108
## Documentation For Models
105109

110+
- [Branch](docs/Branch.md)
111+
- [BranchHead](docs/BranchHead.md)
112+
- [BranchOwningProject](docs/BranchOwningProject.md)
106113
- [Commit](docs/Commit.md)
107-
- [CommitContainingProject](docs/CommitContainingProject.md)
108114
- [CompositeConstraint](docs/CompositeConstraint.md)
109115
- [Constraint](docs/Constraint.md)
110116
- [Element](docs/Element.md)
@@ -115,7 +121,6 @@ Class | Method | HTTP request | Description
115121
- [PrimitiveConstraint](docs/PrimitiveConstraint.md)
116122
- [Project](docs/Project.md)
117123
- [Query](docs/Query.md)
118-
- [Record](docs/Record.md)
119124
- [Relationship](docs/Relationship.md)
120125

121126

‎docs/Branch.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Branch
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**type** | **str** | | [optional]
7+
**head** | [**BranchHead**](BranchHead.md) | | [optional]
8+
**owning_project** | [**BranchOwningProject**](BranchOwningProject.md) | | [optional]
9+
**id** | **str** | | [optional]
10+
**name** | **str** | | [optional]
11+
12+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13+
14+

‎docs/BranchApi.md

Lines changed: 212 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,212 @@
1+
# sysml_v2_api_client.BranchApi
2+
3+
All URIs are relative to *http://localhost*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**get_branches_by_project**](BranchApi.md#get_branches_by_project) | **GET** /projects/{projectId}/branches | Get branches by project
8+
[**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
9+
[**post_branch_by_project**](BranchApi.md#post_branch_by_project) | **POST** /projects/{projectId}/branches | Create branch by project
10+
11+
12+
# **get_branches_by_project**
13+
> list[Branch] get_branches_by_project(project_id, page_after=page_after, page_before=page_before, page_size=page_size)
14+
15+
Get branches by project
16+
17+
### Example
18+
19+
```python
20+
from __future__ import print_function
21+
import time
22+
import sysml_v2_api_client
23+
from sysml_v2_api_client.rest import ApiException
24+
from pprint import pprint
25+
# Defining the host is optional and defaults to http://localhost
26+
# See configuration.py for a list of all supported configuration parameters.
27+
configuration = sysml_v2_api_client.Configuration(
28+
host = "http://localhost"
29+
)
30+
31+
32+
# Enter a context with an instance of the API client
33+
with sysml_v2_api_client.ApiClient() as api_client:
34+
# Create an instance of the API class
35+
api_instance = sysml_v2_api_client.BranchApi(api_client)
36+
project_id = 'project_id_example' # str | ID of the project
37+
page_after = 'page_after_example' # str | Page after (optional)
38+
page_before = 'page_before_example' # str | Page before (optional)
39+
page_size = 56 # int | Page size (optional)
40+
41+
try:
42+
# Get branches by project
43+
api_response = api_instance.get_branches_by_project(project_id, page_after=page_after, page_before=page_before, page_size=page_size)
44+
pprint(api_response)
45+
except ApiException as e:
46+
print("Exception when calling BranchApi->get_branches_by_project: %s\n" % e)
47+
```
48+
49+
### Parameters
50+
51+
Name | Type | Description | Notes
52+
------------- | ------------- | ------------- | -------------
53+
**project_id** | [**str**](.md)| ID of the project |
54+
**page_after** | **str**| Page after | [optional]
55+
**page_before** | **str**| Page before | [optional]
56+
**page_size** | **int**| Page size | [optional]
57+
58+
### Return type
59+
60+
[**list[Branch]**](Branch.md)
61+
62+
### Authorization
63+
64+
No authorization required
65+
66+
### HTTP request headers
67+
68+
- **Content-Type**: Not defined
69+
- **Accept**: application/json
70+
71+
### HTTP response details
72+
| Status code | Description | Response headers |
73+
|-------------|-------------|------------------|
74+
**200** | Ok | - |
75+
**404** | Not found. | - |
76+
**415** | The requested content type is not acceptable. | - |
77+
**500** | Internal server error. | - |
78+
**0** | Unexpected response. | - |
79+
80+
[[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)
81+
82+
# **get_branches_by_project_and_id**
83+
> Branch get_branches_by_project_and_id(project_id, branch_id)
84+
85+
Get branch by project and ID
86+
87+
### Example
88+
89+
```python
90+
from __future__ import print_function
91+
import time
92+
import sysml_v2_api_client
93+
from sysml_v2_api_client.rest import ApiException
94+
from pprint import pprint
95+
# Defining the host is optional and defaults to http://localhost
96+
# See configuration.py for a list of all supported configuration parameters.
97+
configuration = sysml_v2_api_client.Configuration(
98+
host = "http://localhost"
99+
)
100+
101+
102+
# Enter a context with an instance of the API client
103+
with sysml_v2_api_client.ApiClient() as api_client:
104+
# Create an instance of the API class
105+
api_instance = sysml_v2_api_client.BranchApi(api_client)
106+
project_id = 'project_id_example' # str | ID of the project
107+
branch_id = 'branch_id_example' # str | ID of the branch
108+
109+
try:
110+
# Get branch by project and ID
111+
api_response = api_instance.get_branches_by_project_and_id(project_id, branch_id)
112+
pprint(api_response)
113+
except ApiException as e:
114+
print("Exception when calling BranchApi->get_branches_by_project_and_id: %s\n" % e)
115+
```
116+
117+
### Parameters
118+
119+
Name | Type | Description | Notes
120+
------------- | ------------- | ------------- | -------------
121+
**project_id** | [**str**](.md)| ID of the project |
122+
**branch_id** | [**str**](.md)| ID of the branch |
123+
124+
### Return type
125+
126+
[**Branch**](Branch.md)
127+
128+
### Authorization
129+
130+
No authorization required
131+
132+
### HTTP request headers
133+
134+
- **Content-Type**: Not defined
135+
- **Accept**: application/json
136+
137+
### HTTP response details
138+
| Status code | Description | Response headers |
139+
|-------------|-------------|------------------|
140+
**200** | Ok | - |
141+
**404** | Not found. | - |
142+
**415** | The requested content type is not acceptable. | - |
143+
**500** | Internal server error. | - |
144+
**0** | Unexpected response. | - |
145+
146+
[[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)
147+
148+
# **post_branch_by_project**
149+
> Branch post_branch_by_project(project_id, body)
150+
151+
Create branch by project
152+
153+
### Example
154+
155+
```python
156+
from __future__ import print_function
157+
import time
158+
import sysml_v2_api_client
159+
from sysml_v2_api_client.rest import ApiException
160+
from pprint import pprint
161+
# Defining the host is optional and defaults to http://localhost
162+
# See configuration.py for a list of all supported configuration parameters.
163+
configuration = sysml_v2_api_client.Configuration(
164+
host = "http://localhost"
165+
)
166+
167+
168+
# Enter a context with an instance of the API client
169+
with sysml_v2_api_client.ApiClient() as api_client:
170+
# Create an instance of the API class
171+
api_instance = sysml_v2_api_client.BranchApi(api_client)
172+
project_id = 'project_id_example' # str | ID of the project
173+
body = sysml_v2_api_client.Branch() # Branch |
174+
175+
try:
176+
# Create branch by project
177+
api_response = api_instance.post_branch_by_project(project_id, body)
178+
pprint(api_response)
179+
except ApiException as e:
180+
print("Exception when calling BranchApi->post_branch_by_project: %s\n" % e)
181+
```
182+
183+
### Parameters
184+
185+
Name | Type | Description | Notes
186+
------------- | ------------- | ------------- | -------------
187+
**project_id** | [**str**](.md)| ID of the project |
188+
**body** | [**Branch**](Branch.md)| |
189+
190+
### Return type
191+
192+
[**Branch**](Branch.md)
193+
194+
### Authorization
195+
196+
No authorization required
197+
198+
### HTTP request headers
199+
200+
- **Content-Type**: application/json
201+
- **Accept**: application/json
202+
203+
### HTTP response details
204+
| Status code | Description | Response headers |
205+
|-------------|-------------|------------------|
206+
**201** | Created | - |
207+
**415** | The requested content type is not acceptable. | - |
208+
**500** | Internal server error. | - |
209+
**0** | Unexpected response. | - |
210+
211+
[[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)
212+

‎docs/Record.md renamed to ‎docs/BranchHead.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
# Record
1+
# BranchHead
22

3+
Commit
34
## Properties
45
Name | Type | Description | Notes
56
------------ | ------------- | ------------- | -------------

‎docs/CommitContainingProject.md renamed to ‎docs/BranchOwningProject.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
# CommitContainingProject
1+
# BranchOwningProject
22

3+
Project
34
## Properties
45
Name | Type | Description | Notes
56
------------ | ------------- | ------------- | -------------

‎docs/Commit.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**type** | **str** | | [optional]
77
**change** | [**list[ElementVersion]**](ElementVersion.md) | | [optional]
8-
**containing_project** | [**CommitContainingProject**](CommitContainingProject.md) | | [optional]
8+
**owning_project** | [**BranchOwningProject**](BranchOwningProject.md) | | [optional]
99
**id** | **str** | | [optional]
10-
**previous_commit** | [**Record**](Record.md) | | [optional]
10+
**previous_commit** | [**BranchHead**](BranchHead.md) | | [optional]
1111

1212
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1313

0 commit comments

Comments
 (0)