u
This commit is contained in:
34
docs/api/routes/attributename/_attributeId/value.get.md
Normal file
34
docs/api/routes/attributename/_attributeId/value.get.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# `GET /attributename/{attributeId}/value`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
List values for an attribute
|
||||
|
||||
Lists all values for a specific attribute.
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `attributeId` | yes | integer | |
|
||||
|
||||
## Response `200`
|
||||
|
||||
List of attribute values
|
||||
|
||||
```json
|
||||
{
|
||||
"values": [
|
||||
{
|
||||
"id": 1,
|
||||
"attributeId": 1,
|
||||
"value": "…",
|
||||
"sort": 1
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
41
docs/api/routes/attributename/_attributeId/value.post.md
Normal file
41
docs/api/routes/attributename/_attributeId/value.post.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# `POST /attributename/{attributeId}/value`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Create value for an attribute
|
||||
|
||||
Adds a new predefined value to an attribute.
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `attributeId` | yes | integer | |
|
||||
|
||||
## Body (JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"value": "…",
|
||||
"sort": 1
|
||||
}
|
||||
```
|
||||
|
||||
## Response `201`
|
||||
|
||||
Created attribute value
|
||||
|
||||
```json
|
||||
{
|
||||
"attributevalue": {
|
||||
"id": 1,
|
||||
"attributeId": 1,
|
||||
"value": "…",
|
||||
"sort": 1
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
31
docs/api/routes/attributename/_attributeId/value/order.md
Normal file
31
docs/api/routes/attributename/_attributeId/value/order.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# `PUT /attributename/{attributeId}/value/order`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Reorder values of an attribute
|
||||
|
||||
Updates the display sort order of values belonging to an attribute.
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `attributeId` | yes | integer | |
|
||||
|
||||
## Body (JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"attributevalueIds": [
|
||||
1
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Response `200`
|
||||
|
||||
Reordered successfully
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
21
docs/api/routes/attributename/_id.delete.md
Normal file
21
docs/api/routes/attributename/_id.delete.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# `DELETE /attributename/{id}`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Delete attribute name
|
||||
|
||||
Deletes an attribute name and cascades to attribute values and article assignments.
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `id` | yes | integer | |
|
||||
|
||||
## Response `200`
|
||||
|
||||
Deleted successfully
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
50
docs/api/routes/attributename/_id.patch.md
Normal file
50
docs/api/routes/attributename/_id.patch.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# `PATCH /attributename/{id}`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Update attribute name
|
||||
|
||||
Updates name, sort, and/or exclusive flag for an attribute name.
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `id` | yes | integer | |
|
||||
|
||||
## Body (JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "…",
|
||||
"sort": 1,
|
||||
"exclusive": true
|
||||
}
|
||||
```
|
||||
|
||||
## Response `200`
|
||||
|
||||
Updated attribute name
|
||||
|
||||
```json
|
||||
{
|
||||
"attributename": {
|
||||
"id": 1,
|
||||
"name": "…",
|
||||
"sort": 1,
|
||||
"exclusive": true,
|
||||
"values": [
|
||||
{
|
||||
"id": 1,
|
||||
"attributeId": 1,
|
||||
"value": "…",
|
||||
"sort": 1
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
25
docs/api/routes/attributename/order.md
Normal file
25
docs/api/routes/attributename/order.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# `PUT /attributename/order`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Reorder attribute names
|
||||
|
||||
Updates the display sort order of attribute names for the selected company.
|
||||
|
||||
## Body (JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"attributenameIds": [
|
||||
1
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Response `200`
|
||||
|
||||
Reordered successfully
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
Reference in New Issue
Block a user