Skip to content

Commit

Permalink
Merge branch 'release/2021-09'
Browse files Browse the repository at this point in the history
  • Loading branch information
ivan-gomes committed Oct 14, 2021
2 parents 97248d0 + dd6aa5d commit 8971105
Show file tree
Hide file tree
Showing 40 changed files with 2,418 additions and 128 deletions.
26 changes: 17 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ REST/HTTP binding (PSM) for the SysML v2 standard API.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 2021-06
- Package version: 2021-09
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.
Expand Down Expand Up @@ -65,16 +65,14 @@ with sysml_v2_api_client.ApiClient(configuration) 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)
branch_id = 'branch_id_example' # str | ID of the branch

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

```

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*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
*BranchApi* | [**get_branches_by_project**](docs/BranchApi.md#get_branches_by_project) | **GET** /projects/{projectId}/branches | Get branches by project
*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
*BranchApi* | [**post_branch_by_project**](docs/BranchApi.md#post_branch_by_project) | **POST** /projects/{projectId}/branches | Create branch by project
Expand All @@ -93,16 +92,23 @@ Class | Method | HTTP request | Description
*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
*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
*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
*ProjectApi* | [**delete_project_by_id**](docs/ProjectApi.md#delete_project_by_id) | **DELETE** /projects/{projectId} | Delete project by ID
*ProjectApi* | [**get_project_by_id**](docs/ProjectApi.md#get_project_by_id) | **GET** /projects/{projectId} | Get project by ID
*ProjectApi* | [**get_projects**](docs/ProjectApi.md#get_projects) | **GET** /projects | Get projects
*ProjectApi* | [**post_project**](docs/ProjectApi.md#post_project) | **POST** /projects | Create project
*ProjectApi* | [**put_project_by_id**](docs/ProjectApi.md#put_project_by_id) | **PUT** /projects/{projectId} | Update project by ID
*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
*QueryApi* | [**get_queries_by_project**](docs/QueryApi.md#get_queries_by_project) | **GET** /projects/{projectId}/queries | Get queries by project
*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
*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
*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
*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
*QueryApi* | [**post_query_by_project**](docs/QueryApi.md#post_query_by_project) | **POST** /projects/{projectId}/queries | Create query by project
*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
*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
*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
*TagApi* | [**get_tags_by_project**](docs/TagApi.md#get_tags_by_project) | **GET** /projects/{projectId}/tags | Get tags by project
*TagApi* | [**post_tag_by_project**](docs/TagApi.md#post_tag_by_project) | **POST** /projects/{projectId}/tags | Create tag by project


## Documentation For Models
Expand All @@ -113,16 +119,18 @@ Class | Method | HTTP request | Description
- [Commit](docs/Commit.md)
- [CompositeConstraint](docs/CompositeConstraint.md)
- [Constraint](docs/Constraint.md)
- [Data](docs/Data.md)
- [DataIdentity](docs/DataIdentity.md)
- [DataVersion](docs/DataVersion.md)
- [Element](docs/Element.md)
- [ElementIdentity](docs/ElementIdentity.md)
- [ElementVersion](docs/ElementVersion.md)
- [Error](docs/Error.md)
- [Identified](docs/Identified.md)
- [PrimitiveConstraint](docs/PrimitiveConstraint.md)
- [Project](docs/Project.md)
- [ProjectDefaultBranch](docs/ProjectDefaultBranch.md)
- [Query](docs/Query.md)
- [Relationship](docs/Relationship.md)
- [Tag](docs/Tag.md)


## Documentation For Authorization
Expand Down
4 changes: 3 additions & 1 deletion docs/Branch.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ Name | Type | Description | Notes
**id** | **str** | | [optional]
**type** | **str** | | [optional]
**head** | [**BranchHead**](BranchHead.md) | | [optional]
**owning_project** | [**BranchOwningProject**](BranchOwningProject.md) | | [optional]
**name** | **str** | | [optional]
**owning_project** | [**BranchOwningProject**](BranchOwningProject.md) | | [optional]
**referenced_commit** | [**BranchHead**](BranchHead.md) | | [optional]
**timestamp** | **datetime** | | [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)

Expand Down
67 changes: 67 additions & 0 deletions docs/BranchApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,78 @@ All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**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
[**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


# **delete_branch_by_project_and_id**
> Branch delete_branch_by_project_and_id(project_id, branch_id)
Delete 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:
# Delete branch by project and ID
api_response = api_instance.delete_branch_by_project_and_id(project_id, branch_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling BranchApi->delete_branch_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, application/ld+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**
> list[Branch] get_branches_by_project(project_id, page_after=page_after, page_before=page_before, page_size=page_size)
Expand Down
2 changes: 1 addition & 1 deletion docs/Commit.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | | [optional]
**type** | **str** | | [optional]
**change** | [**list[ElementVersion]**](ElementVersion.md) | | [optional]
**change** | [**list[DataVersion]**](DataVersion.md) | | [optional]
**owning_project** | [**BranchOwningProject**](BranchOwningProject.md) | | [optional]
**previous_commit** | [**BranchHead**](BranchHead.md) | | [optional]

Expand Down
11 changes: 11 additions & 0 deletions docs/Data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Data

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | | [optional]
**type** | **str** | |

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


2 changes: 1 addition & 1 deletion docs/ElementIdentity.md → docs/DataIdentity.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ElementIdentity
# DataIdentity

## Properties
Name | Type | Description | Notes
Expand Down
6 changes: 3 additions & 3 deletions docs/ElementVersion.md → docs/DataVersion.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# ElementVersion
# DataVersion

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | | [optional]
**type** | **str** | | [optional]
**data** | [**Element**](Element.md) | | [optional]
**identity** | [**ElementIdentity**](ElementIdentity.md) | | [optional]
**payload** | [**Data**](Data.md) | | [optional]
**identity** | [**DataIdentity**](DataIdentity.md) | | [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)

Expand Down
131 changes: 131 additions & 0 deletions docs/ProjectApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,77 @@ All URIs are relative to *http://localhost*

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


# **delete_project_by_id**
> Project delete_project_by_id(project_id)
Delete project by 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.ProjectApi(api_client)
project_id = 'project_id_example' # str | ID of the project

try:
# Delete project by ID
api_response = api_instance.delete_project_by_id(project_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ProjectApi->delete_project_by_id: %s\n" % e)
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**project_id** | [**str**](.md)| ID of the project |

### Return type

[**Project**](Project.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/ld+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_project_by_id**
> Project get_project_by_id(project_id)
Expand Down Expand Up @@ -203,3 +269,68 @@ No authorization required

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

# **put_project_by_id**
> Project put_project_by_id(project_id, body=body)
Update project by 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.ProjectApi(api_client)
project_id = 'project_id_example' # str | ID of the project
body = sysml_v2_api_client.Project() # Project | (optional)

try:
# Update project by ID
api_response = api_instance.put_project_by_id(project_id, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ProjectApi->put_project_by_id: %s\n" % e)
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**project_id** | [**str**](.md)| ID of the project |
**body** | [**Project**](Project.md)| | [optional]

### Return type

[**Project**](Project.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json, application/ld+json

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Ok | - |
**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)

2 changes: 1 addition & 1 deletion docs/Query.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Name | Type | Description | Notes
**id** | **str** | | [optional]
**type** | **str** | | [optional]
**owning_project** | [**BranchOwningProject**](BranchOwningProject.md) | | [optional]
**scope** | [**list[ElementIdentity]**](ElementIdentity.md) | | [optional]
**scope** | [**list[DataIdentity]**](DataIdentity.md) | | [optional]
**select** | **list[str]** | | [optional]
**where** | [**Constraint**](Constraint.md) | | [optional]

Expand Down
Loading

0 comments on commit 8971105

Please sign in to comment.