Skip to content

Commit e6b129a

Browse files
ivan-gomesivan-gomes
committed
Regenerated for SysML-v2-API-Services 2019-05-rc1
1 parent 3bec881 commit e6b129a

File tree

15 files changed

+1293
-634
lines changed

15 files changed

+1293
-634
lines changed

‎docs/Element.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,9 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7+
**atType** | **String** | | [optional]
8+
**containingProject** | [**Identified**](Identified.md) | | [optional]
79
**identifier** | [**UUID**](UUID.md) | | [optional]
8-
**name** | **String** | | [optional]
9-
**description** | **String** | | [optional]
10-
**parentModel** | [**UUID**](UUID.md) | | [optional]
11-
**type** | **String** | | [optional]
1210

1311

1412

‎docs/ElementApi.md

Lines changed: 66 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,16 @@ All URIs are relative to *http://localhost*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**createElement**](ElementApi.md#createElement) | **POST** /element | Add a new element
8-
[**getElement**](ElementApi.md#getElement) | **GET** /element/{id} | Get element by its ID
9-
[**getElements**](ElementApi.md#getElements) | **GET** /element | Get all elements
10-
[**getElementsInModel**](ElementApi.md#getElementsInModel) | **GET** /element/model/{model_id} | Get all elements in the model
7+
[**createElement**](ElementApi.md#createElement) | **POST** /elements | Add a new element
8+
[**getElement**](ElementApi.md#getElement) | **GET** /elements/{identifier} | Get element by its ID
9+
[**getElementByProjectAndId**](ElementApi.md#getElementByProjectAndId) | **GET** /projects/{project_identifier}/elements/{element_identifier} | Get element by project ID and its ID
10+
[**getElements**](ElementApi.md#getElements) | **GET** /elements | Get all elements
11+
[**getElementsInProject**](ElementApi.md#getElementsInProject) | **GET** /projects/{project_identifier}/elements | Get all elements in the project
1112

1213

1314
<a name="createElement"></a>
1415
# **createElement**
15-
> Element createElement(element)
16+
> Element createElement(requestBody)
1617
1718
Add a new element
1819

@@ -24,9 +25,9 @@ Add a new element
2425

2526

2627
ElementApi apiInstance = new ElementApi();
27-
Element element = new Element(); // Element |
28+
Map<String, Object> requestBody = null; // Map<String, Object> |
2829
try {
29-
Element result = apiInstance.createElement(element);
30+
Element result = apiInstance.createElement(requestBody);
3031
System.out.println(result);
3132
} catch (ApiException e) {
3233
System.err.println("Exception when calling ElementApi#createElement");
@@ -38,7 +39,7 @@ try {
3839

3940
Name | Type | Description | Notes
4041
------------- | ------------- | ------------- | -------------
41-
**element** | [**Element**](Element.md)| |
42+
**requestBody** | [**Map&lt;String, Object&gt;**](Object.md)| |
4243

4344
### Return type
4445

@@ -55,7 +56,7 @@ No authorization required
5556

5657
<a name="getElement"></a>
5758
# **getElement**
58-
> Element getElement(id)
59+
> Element getElement(identifier)
5960
6061
Get element by its ID
6162

@@ -67,9 +68,9 @@ Get element by its ID
6768

6869

6970
ElementApi apiInstance = new ElementApi();
70-
String id = "id_example"; // String | ID of the element
71+
String identifier = "identifier_example"; // String | ID of the element
7172
try {
72-
Element result = apiInstance.getElement(id);
73+
Element result = apiInstance.getElement(identifier);
7374
System.out.println(result);
7475
} catch (ApiException e) {
7576
System.err.println("Exception when calling ElementApi#getElement");
@@ -81,7 +82,52 @@ try {
8182

8283
Name | Type | Description | Notes
8384
------------- | ------------- | ------------- | -------------
84-
**id** | **String**| ID of the element |
85+
**identifier** | **String**| ID of the element |
86+
87+
### Return type
88+
89+
[**Element**](Element.md)
90+
91+
### Authorization
92+
93+
No authorization required
94+
95+
### HTTP request headers
96+
97+
- **Content-Type**: Not defined
98+
- **Accept**: application/json
99+
100+
<a name="getElementByProjectAndId"></a>
101+
# **getElementByProjectAndId**
102+
> Element getElementByProjectAndId(projectIdentifier, elementIdentifier)
103+
104+
Get element by project ID and its ID
105+
106+
### Example
107+
```java
108+
// Import classes:
109+
//import org.omg.sysml.ApiException;
110+
//import org.omg.sysml.api.ElementApi;
111+
112+
113+
ElementApi apiInstance = new ElementApi();
114+
String projectIdentifier = "projectIdentifier_example"; // String | ID of the project
115+
String elementIdentifier = "elementIdentifier_example"; // String | ID of the element
116+
try {
117+
Element result = apiInstance.getElementByProjectAndId(projectIdentifier, elementIdentifier);
118+
System.out.println(result);
119+
} catch (ApiException e) {
120+
System.err.println("Exception when calling ElementApi#getElementByProjectAndId");
121+
e.printStackTrace();
122+
}
123+
```
124+
125+
### Parameters
126+
127+
Name | Type | Description | Notes
128+
------------- | ------------- | ------------- | -------------
129+
**projectIdentifier** | **String**| ID of the project |
130+
**elementIdentifier** | **String**| ID of the element |
85131

86132
### Return type
87133

@@ -135,11 +181,11 @@ No authorization required
135181
- **Content-Type**: Not defined
136182
- **Accept**: application/json
137183

138-
<a name="getElementsInModel"></a>
139-
# **getElementsInModel**
140-
> Element getElementsInModel(modelId)
184+
<a name="getElementsInProject"></a>
185+
# **getElementsInProject**
186+
> Element getElementsInProject(projectIdentifier)
141187
142-
Get all elements in the model
188+
Get all elements in the project
143189

144190
### Example
145191
```java
@@ -149,12 +195,12 @@ Get all elements in the model
149195

150196

151197
ElementApi apiInstance = new ElementApi();
152-
String modelId = "modelId_example"; // String | ID of the model
198+
String projectIdentifier = "projectIdentifier_example"; // String | ID of the project
153199
try {
154-
Element result = apiInstance.getElementsInModel(modelId);
200+
Element result = apiInstance.getElementsInProject(projectIdentifier);
155201
System.out.println(result);
156202
} catch (ApiException e) {
157-
System.err.println("Exception when calling ElementApi#getElementsInModel");
203+
System.err.println("Exception when calling ElementApi#getElementsInProject");
158204
e.printStackTrace();
159205
}
160206
```
@@ -163,7 +209,7 @@ try {
163209

164210
Name | Type | Description | Notes
165211
------------- | ------------- | ------------- | -------------
166-
**modelId** | **String**| ID of the model |
212+
**projectIdentifier** | **String**| ID of the project |
167213

168214
### Return type
169215

‎docs/Identified.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
2+
# Identified
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**identifier** | [**UUID**](UUID.md) | | [optional]
8+
9+
10+

‎docs/Project.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
2+
# Project
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**atType** | **String** | | [optional]
8+
**name** | **String** | | [optional]
9+
**identifier** | [**UUID**](UUID.md) | | [optional]
10+
11+
12+

‎docs/ProjectApi.md

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
# ProjectApi
2+
3+
All URIs are relative to *http://localhost*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**createProject**](ProjectApi.md#createProject) | **POST** /projects | Add a new project
8+
[**getProject**](ProjectApi.md#getProject) | **GET** /projects/{identifier} | Get project by its ID
9+
[**getProjects**](ProjectApi.md#getProjects) | **GET** /projects | Get all projects
10+
11+
12+
<a name="createProject"></a>
13+
# **createProject**
14+
> Project createProject(project)
15+
16+
Add a new project
17+
18+
### Example
19+
```java
20+
// Import classes:
21+
//import org.omg.sysml.ApiException;
22+
//import org.omg.sysml.api.ProjectApi;
23+
24+
25+
ProjectApi apiInstance = new ProjectApi();
26+
Project project = new Project(); // Project |
27+
try {
28+
Project result = apiInstance.createProject(project);
29+
System.out.println(result);
30+
} catch (ApiException e) {
31+
System.err.println("Exception when calling ProjectApi#createProject");
32+
e.printStackTrace();
33+
}
34+
```
35+
36+
### Parameters
37+
38+
Name | Type | Description | Notes
39+
------------- | ------------- | ------------- | -------------
40+
**project** | [**Project**](Project.md)| | [optional]
41+
42+
### Return type
43+
44+
[**Project**](Project.md)
45+
46+
### Authorization
47+
48+
No authorization required
49+
50+
### HTTP request headers
51+
52+
- **Content-Type**: application/json
53+
- **Accept**: application/json
54+
55+
<a name="getProject"></a>
56+
# **getProject**
57+
> Project getProject(identifier)
58+
59+
Get project by its ID
60+
61+
### Example
62+
```java
63+
// Import classes:
64+
//import org.omg.sysml.ApiException;
65+
//import org.omg.sysml.api.ProjectApi;
66+
67+
68+
ProjectApi apiInstance = new ProjectApi();
69+
String identifier = "identifier_example"; // String | ID of the project
70+
try {
71+
Project result = apiInstance.getProject(identifier);
72+
System.out.println(result);
73+
} catch (ApiException e) {
74+
System.err.println("Exception when calling ProjectApi#getProject");
75+
e.printStackTrace();
76+
}
77+
```
78+
79+
### Parameters
80+
81+
Name | Type | Description | Notes
82+
------------- | ------------- | ------------- | -------------
83+
**identifier** | **String**| ID of the project |
84+
85+
### Return type
86+
87+
[**Project**](Project.md)
88+
89+
### Authorization
90+
91+
No authorization required
92+
93+
### HTTP request headers
94+
95+
- **Content-Type**: Not defined
96+
- **Accept**: application/json
97+
98+
<a name="getProjects"></a>
99+
# **getProjects**
100+
> List&lt;Project&gt; getProjects()
101+
102+
Get all projects
103+
104+
### Example
105+
```java
106+
// Import classes:
107+
//import org.omg.sysml.ApiException;
108+
//import org.omg.sysml.api.ProjectApi;
109+
110+
111+
ProjectApi apiInstance = new ProjectApi();
112+
try {
113+
List<Project> result = apiInstance.getProjects();
114+
System.out.println(result);
115+
} catch (ApiException e) {
116+
System.err.println("Exception when calling ProjectApi#getProjects");
117+
e.printStackTrace();
118+
}
119+
```
120+
121+
### Parameters
122+
This endpoint does not need any parameter.
123+
124+
### Return type
125+
126+
[**List&lt;Project&gt;**](Project.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+

‎docs/Relationship.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,8 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**sourceElementRole** | **String** | | [optional]
8-
**sourceElement** | [**UUID**](UUID.md) | | [optional]
9-
**targetElementRole** | **String** | | [optional]
10-
**targetElement** | [**UUID**](UUID.md) | | [optional]
7+
**source** | [**List&lt;Identified&gt;**](Identified.md) | | [optional]
8+
**target** | [**List&lt;Identified&gt;**](Identified.md) | | [optional]
119

1210

1311

0 commit comments

Comments
 (0)