about summary refs log tree commit diff stats
path: root/crates/rocie-client/docs/ApiGetAuthProductParentApi.md
blob: f51a316b3029bb713a17edf66a4fcf37d8d6b721 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# \\ApiGetAuthProductParentApi

All URIs are relative to _http://localhost_

| Method                                                                                 | HTTP request                        | Description                                                            |
| -------------------------------------------------------------------------------------- | ----------------------------------- | ---------------------------------------------------------------------- |
| [**product_parents**](ApiGetAuthProductParentApi.md#product_parents)                   | **GET** /product_parents/           | Return all registered product parents                                  |
| [**product_parents_toplevel**](ApiGetAuthProductParentApi.md#product_parents_toplevel) | **GET** /product_parents_toplevel/  | Return all registered product parents, that have no parents themselves |
| [**product_parents_under**](ApiGetAuthProductParentApi.md#product_parents_under)       | **GET** /product_parents_under/{id} | Return all parents, that have this parent as parent                    |

## product_parents

> Vec<models::ProductParent> product_parents() Return all registered product
> parents

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::ProductParent>**](ProductParent.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/plain

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

## product_parents_toplevel

> Vec<models::ProductParent> product_parents_toplevel() Return all registered
> product parents, that have no parents themselves

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::ProductParent>**](ProductParent.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/plain

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

## product_parents_under

> Vec<models::ProductParent> product_parents_under(id) Return all parents, that
> have this parent as parent

### Parameters

| Name   | Type                       | Description       | Required   | Notes |
| ------ | -------------------------- | ----------------- | ---------- | ----- |
| **id** | [**ProductParentId**](.md) | Product parent id | [required] |

### Return type

[**Vec<models::ProductParent>**](ProductParent.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, text/plain

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