Skip to content

Commit 8971105

Browse files
ivan-gomesivan-gomes
committed
Merge branch 'release/2021-09'
2 parents 97248d0 + dd6aa5d commit 8971105

40 files changed

+2418
-128
lines changed

‎README.md

+17-9
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-06
7+
- Package version: 2021-09
88
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
99

1010
## Requirements.
@@ -65,16 +65,14 @@ with sysml_v2_api_client.ApiClient(configuration) as api_client:
6565
# Create an instance of the API class
6666
api_instance = sysml_v2_api_client.BranchApi(api_client)
6767
project_id = 'project_id_example' # str | ID of the project
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)
68+
branch_id = 'branch_id_example' # str | ID of the branch
7169

7270
try:
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)
71+
# Delete branch by project and ID
72+
api_response = api_instance.delete_branch_by_project_and_id(project_id, branch_id)
7573
pprint(api_response)
7674
except ApiException as e:
77-
print("Exception when calling BranchApi->get_branches_by_project: %s\n" % e)
75+
print("Exception when calling BranchApi->delete_branch_by_project_and_id: %s\n" % e)
7876

7977
```
8078

@@ -84,6 +82,7 @@ All URIs are relative to *http://localhost*
8482

8583
Class | Method | HTTP request | Description
8684
------------ | ------------- | ------------- | -------------
85+
*BranchApi* | [**delete_branch_by_project_and_id**](docs/BranchApi.md#delete_branch_by_project_and_id) | **DELETE** /projects/{projectId}/branches/{branchId} | Delete branch by project and ID
8786
*BranchApi* | [**get_branches_by_project**](docs/BranchApi.md#get_branches_by_project) | **GET** /projects/{projectId}/branches | Get branches by project
8887
*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
8988
*BranchApi* | [**post_branch_by_project**](docs/BranchApi.md#post_branch_by_project) | **POST** /projects/{projectId}/branches | Create branch by project
@@ -93,16 +92,23 @@ Class | Method | HTTP request | Description
9392
*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
9493
*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
9594
*ElementApi* | [**get_roots_by_project_commit**](docs/ElementApi.md#get_roots_by_project_commit) | **GET** /projects/{projectId}/commits/{commitId}/roots | Get root elements by project and commit
95+
*ProjectApi* | [**delete_project_by_id**](docs/ProjectApi.md#delete_project_by_id) | **DELETE** /projects/{projectId} | Delete project by ID
9696
*ProjectApi* | [**get_project_by_id**](docs/ProjectApi.md#get_project_by_id) | **GET** /projects/{projectId} | Get project by ID
9797
*ProjectApi* | [**get_projects**](docs/ProjectApi.md#get_projects) | **GET** /projects | Get projects
9898
*ProjectApi* | [**post_project**](docs/ProjectApi.md#post_project) | **POST** /projects | Create project
99+
*ProjectApi* | [**put_project_by_id**](docs/ProjectApi.md#put_project_by_id) | **PUT** /projects/{projectId} | Update project by ID
100+
*QueryApi* | [**delete_query_by_project_and_id**](docs/QueryApi.md#delete_query_by_project_and_id) | **DELETE** /projects/{projectId}/queries/{queryId} | Delete query by project and ID
99101
*QueryApi* | [**get_queries_by_project**](docs/QueryApi.md#get_queries_by_project) | **GET** /projects/{projectId}/queries | Get queries by project
100102
*QueryApi* | [**get_query_by_project_and_id**](docs/QueryApi.md#get_query_by_project_and_id) | **GET** /projects/{projectId}/queries/{queryId} | Get query by project and ID
101103
*QueryApi* | [**get_query_results_by_project_id_query**](docs/QueryApi.md#get_query_results_by_project_id_query) | **GET** /projects/{projectId}/query-results | Get query results by project and query definition
102104
*QueryApi* | [**get_query_results_by_project_id_query_id**](docs/QueryApi.md#get_query_results_by_project_id_query_id) | **GET** /projects/{projectId}/queries/{queryId}/results | Get query results by project and query
103105
*QueryApi* | [**get_query_results_by_project_id_query_post**](docs/QueryApi.md#get_query_results_by_project_id_query_post) | **POST** /projects/{projectId}/query-results | Get query results by project and query definition via POST
104106
*QueryApi* | [**post_query_by_project**](docs/QueryApi.md#post_query_by_project) | **POST** /projects/{projectId}/queries | Create query by project
105107
*RelationshipApi* | [**get_relationships_by_project_commit_related_element**](docs/RelationshipApi.md#get_relationships_by_project_commit_related_element) | **GET** /projects/{projectId}/commits/{commitId}/elements/{relatedElementId}/relationships | Get relationships by project, commit, and related element
108+
*TagApi* | [**delete_tag_by_project_and_id**](docs/TagApi.md#delete_tag_by_project_and_id) | **DELETE** /projects/{projectId}/tags/{tagId} | Delete tag by project and ID
109+
*TagApi* | [**get_tag_by_project_and_id**](docs/TagApi.md#get_tag_by_project_and_id) | **GET** /projects/{projectId}/tags/{tagId} | Get tag by project and ID
110+
*TagApi* | [**get_tags_by_project**](docs/TagApi.md#get_tags_by_project) | **GET** /projects/{projectId}/tags | Get tags by project
111+
*TagApi* | [**post_tag_by_project**](docs/TagApi.md#post_tag_by_project) | **POST** /projects/{projectId}/tags | Create tag by project
106112

107113

108114
## Documentation For Models
@@ -113,16 +119,18 @@ Class | Method | HTTP request | Description
113119
- [Commit](docs/Commit.md)
114120
- [CompositeConstraint](docs/CompositeConstraint.md)
115121
- [Constraint](docs/Constraint.md)
122+
- [Data](docs/Data.md)
123+
- [DataIdentity](docs/DataIdentity.md)
124+
- [DataVersion](docs/DataVersion.md)
116125
- [Element](docs/Element.md)
117-
- [ElementIdentity](docs/ElementIdentity.md)
118-
- [ElementVersion](docs/ElementVersion.md)
119126
- [Error](docs/Error.md)
120127
- [Identified](docs/Identified.md)
121128
- [PrimitiveConstraint](docs/PrimitiveConstraint.md)
122129
- [Project](docs/Project.md)
123130
- [ProjectDefaultBranch](docs/ProjectDefaultBranch.md)
124131
- [Query](docs/Query.md)
125132
- [Relationship](docs/Relationship.md)
133+
- [Tag](docs/Tag.md)
126134

127135

128136
## Documentation For Authorization

‎docs/Branch.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@ Name | Type | Description | Notes
66
**id** | **str** | | [optional]
77
**type** | **str** | | [optional]
88
**head** | [**BranchHead**](BranchHead.md) | | [optional]
9-
**owning_project** | [**BranchOwningProject**](BranchOwningProject.md) | | [optional]
109
**name** | **str** | | [optional]
10+
**owning_project** | [**BranchOwningProject**](BranchOwningProject.md) | | [optional]
11+
**referenced_commit** | [**BranchHead**](BranchHead.md) | | [optional]
12+
**timestamp** | **datetime** | | [optional]
1113

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

‎docs/BranchApi.md

+67
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,78 @@ All URIs are relative to *http://localhost*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7+
[**delete_branch_by_project_and_id**](BranchApi.md#delete_branch_by_project_and_id) | **DELETE** /projects/{projectId}/branches/{branchId} | Delete branch by project and ID
78
[**get_branches_by_project**](BranchApi.md#get_branches_by_project) | **GET** /projects/{projectId}/branches | Get branches by project
89
[**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
910
[**post_branch_by_project**](BranchApi.md#post_branch_by_project) | **POST** /projects/{projectId}/branches | Create branch by project
1011

1112

13+
# **delete_branch_by_project_and_id**
14+
> Branch delete_branch_by_project_and_id(project_id, branch_id)
15+
16+
Delete branch 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+
# Defining the host is optional and defaults to http://localhost
27+
# See configuration.py for a list of all supported configuration parameters.
28+
configuration = sysml_v2_api_client.Configuration(
29+
host = "http://localhost"
30+
)
31+
32+
33+
# Enter a context with an instance of the API client
34+
with sysml_v2_api_client.ApiClient() as api_client:
35+
# Create an instance of the API class
36+
api_instance = sysml_v2_api_client.BranchApi(api_client)
37+
project_id = 'project_id_example' # str | ID of the project
38+
branch_id = 'branch_id_example' # str | ID of the branch
39+
40+
try:
41+
# Delete branch by project and ID
42+
api_response = api_instance.delete_branch_by_project_and_id(project_id, branch_id)
43+
pprint(api_response)
44+
except ApiException as e:
45+
print("Exception when calling BranchApi->delete_branch_by_project_and_id: %s\n" % e)
46+
```
47+
48+
### Parameters
49+
50+
Name | Type | Description | Notes
51+
------------- | ------------- | ------------- | -------------
52+
**project_id** | [**str**](.md)| ID of the project |
53+
**branch_id** | [**str**](.md)| ID of the branch |
54+
55+
### Return type
56+
57+
[**Branch**](Branch.md)
58+
59+
### Authorization
60+
61+
No authorization required
62+
63+
### HTTP request headers
64+
65+
- **Content-Type**: Not defined
66+
- **Accept**: application/json, application/ld+json
67+
68+
### HTTP response details
69+
| Status code | Description | Response headers |
70+
|-------------|-------------|------------------|
71+
**200** | Ok | - |
72+
**404** | Not found. | - |
73+
**415** | The requested content type is not acceptable. | - |
74+
**500** | Internal server error. | - |
75+
**0** | Unexpected response. | - |
76+
77+
[[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)
78+
1279
# **get_branches_by_project**
1380
> list[Branch] get_branches_by_project(project_id, page_after=page_after, page_before=page_before, page_size=page_size)
1481

‎docs/Commit.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**id** | **str** | | [optional]
77
**type** | **str** | | [optional]
8-
**change** | [**list[ElementVersion]**](ElementVersion.md) | | [optional]
8+
**change** | [**list[DataVersion]**](DataVersion.md) | | [optional]
99
**owning_project** | [**BranchOwningProject**](BranchOwningProject.md) | | [optional]
1010
**previous_commit** | [**BranchHead**](BranchHead.md) | | [optional]
1111

‎docs/Data.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Data
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **str** | | [optional]
7+
**type** | **str** | |
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

‎docs/ElementIdentity.md renamed to ‎docs/DataIdentity.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ElementIdentity
1+
# DataIdentity
22

33
## Properties
44
Name | Type | Description | Notes

‎docs/ElementVersion.md renamed to ‎docs/DataVersion.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# ElementVersion
1+
# DataVersion
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**id** | **str** | | [optional]
77
**type** | **str** | | [optional]
8-
**data** | [**Element**](Element.md) | | [optional]
9-
**identity** | [**ElementIdentity**](ElementIdentity.md) | | [optional]
8+
**payload** | [**Data**](Data.md) | | [optional]
9+
**identity** | [**DataIdentity**](DataIdentity.md) | | [optional]
1010

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

‎docs/ProjectApi.md

+131
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,77 @@ All URIs are relative to *http://localhost*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7+
[**delete_project_by_id**](ProjectApi.md#delete_project_by_id) | **DELETE** /projects/{projectId} | Delete project by ID
78
[**get_project_by_id**](ProjectApi.md#get_project_by_id) | **GET** /projects/{projectId} | Get project by ID
89
[**get_projects**](ProjectApi.md#get_projects) | **GET** /projects | Get projects
910
[**post_project**](ProjectApi.md#post_project) | **POST** /projects | Create project
11+
[**put_project_by_id**](ProjectApi.md#put_project_by_id) | **PUT** /projects/{projectId} | Update project by ID
1012

1113

14+
# **delete_project_by_id**
15+
> Project delete_project_by_id(project_id)
16+
17+
Delete project by ID
18+
19+
### Example
20+
21+
```python
22+
from __future__ import print_function
23+
import time
24+
import sysml_v2_api_client
25+
from sysml_v2_api_client.rest import ApiException
26+
from pprint import pprint
27+
# Defining the host is optional and defaults to http://localhost
28+
# See configuration.py for a list of all supported configuration parameters.
29+
configuration = sysml_v2_api_client.Configuration(
30+
host = "http://localhost"
31+
)
32+
33+
34+
# Enter a context with an instance of the API client
35+
with sysml_v2_api_client.ApiClient() as api_client:
36+
# Create an instance of the API class
37+
api_instance = sysml_v2_api_client.ProjectApi(api_client)
38+
project_id = 'project_id_example' # str | ID of the project
39+
40+
try:
41+
# Delete project by ID
42+
api_response = api_instance.delete_project_by_id(project_id)
43+
pprint(api_response)
44+
except ApiException as e:
45+
print("Exception when calling ProjectApi->delete_project_by_id: %s\n" % e)
46+
```
47+
48+
### Parameters
49+
50+
Name | Type | Description | Notes
51+
------------- | ------------- | ------------- | -------------
52+
**project_id** | [**str**](.md)| ID of the project |
53+
54+
### Return type
55+
56+
[**Project**](Project.md)
57+
58+
### Authorization
59+
60+
No authorization required
61+
62+
### HTTP request headers
63+
64+
- **Content-Type**: Not defined
65+
- **Accept**: application/json, application/ld+json
66+
67+
### HTTP response details
68+
| Status code | Description | Response headers |
69+
|-------------|-------------|------------------|
70+
**200** | Ok | - |
71+
**404** | Not found. | - |
72+
**415** | The requested content type is not acceptable. | - |
73+
**500** | Internal server error. | - |
74+
**0** | Unexpected response. | - |
75+
76+
[[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)
77+
1278
# **get_project_by_id**
1379
> Project get_project_by_id(project_id)
1480
@@ -203,3 +269,68 @@ No authorization required
203269

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

272+
# **put_project_by_id**
273+
> Project put_project_by_id(project_id, body=body)
274+
275+
Update project by ID
276+
277+
### Example
278+
279+
```python
280+
from __future__ import print_function
281+
import time
282+
import sysml_v2_api_client
283+
from sysml_v2_api_client.rest import ApiException
284+
from pprint import pprint
285+
# Defining the host is optional and defaults to http://localhost
286+
# See configuration.py for a list of all supported configuration parameters.
287+
configuration = sysml_v2_api_client.Configuration(
288+
host = "http://localhost"
289+
)
290+
291+
292+
# Enter a context with an instance of the API client
293+
with sysml_v2_api_client.ApiClient() as api_client:
294+
# Create an instance of the API class
295+
api_instance = sysml_v2_api_client.ProjectApi(api_client)
296+
project_id = 'project_id_example' # str | ID of the project
297+
body = sysml_v2_api_client.Project() # Project | (optional)
298+
299+
try:
300+
# Update project by ID
301+
api_response = api_instance.put_project_by_id(project_id, body=body)
302+
pprint(api_response)
303+
except ApiException as e:
304+
print("Exception when calling ProjectApi->put_project_by_id: %s\n" % e)
305+
```
306+
307+
### Parameters
308+
309+
Name | Type | Description | Notes
310+
------------- | ------------- | ------------- | -------------
311+
**project_id** | [**str**](.md)| ID of the project |
312+
**body** | [**Project**](Project.md)| | [optional]
313+
314+
### Return type
315+
316+
[**Project**](Project.md)
317+
318+
### Authorization
319+
320+
No authorization required
321+
322+
### HTTP request headers
323+
324+
- **Content-Type**: application/json
325+
- **Accept**: application/json, application/ld+json
326+
327+
### HTTP response details
328+
| Status code | Description | Response headers |
329+
|-------------|-------------|------------------|
330+
**200** | Ok | - |
331+
**415** | The requested content type is not acceptable. | - |
332+
**500** | Internal server error. | - |
333+
**0** | Unexpected response. | - |
334+
335+
[[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)
336+

‎docs/Query.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
66
**id** | **str** | | [optional]
77
**type** | **str** | | [optional]
88
**owning_project** | [**BranchOwningProject**](BranchOwningProject.md) | | [optional]
9-
**scope** | [**list[ElementIdentity]**](ElementIdentity.md) | | [optional]
9+
**scope** | [**list[DataIdentity]**](DataIdentity.md) | | [optional]
1010
**select** | **list[str]** | | [optional]
1111
**where** | [**Constraint**](Constraint.md) | | [optional]
1212

0 commit comments

Comments
 (0)