| Method and Path | Description | ||
|---|---|---|---|
| POST | /tags | ||
| GET | /tags/:tagId | ||
| GET | /tags/:tagId/objects | Access to the object set of a Tag, provides basic slice type cursor access. |
|
| http://api.apibuilder.io/bml/annotation/0.0.1/service.json |
| http://api.apibuilder.io/bml/validation/0.0.1/service.json |
| Name | Value | Description |
|---|---|---|
| HEALTHY | HEALTHY | |
| UNHEALTHY | UNHEALTHY |
| Name | Value | Description |
|---|---|---|
| id | id | |
| createdAt | createdAt | |
| updatedAt | updatedAt |
| Name | Value | Description |
|---|---|---|
| STARTING_UP | STARTING_UP | |
| RUNNING | RUNNING | |
| SHUTTING_DOWN | SHUTTING_DOWN |
| Name | Value | Description |
|---|---|---|
| asc | asc | |
| desc | desc |
| Name | Value | Description |
|---|---|---|
| name | name | |
| createdAt | createdAt | |
| updatedAt | updatedAt |
Interfaces: None
A response model for the standard health check resource.
| Field | Type | Required? | Default | Description | Annotations |
|---|---|---|---|---|---|
| health | healthCode | Yes | - | A general health status code.
Example: HEALTHY |
|
| status | serviceStatus | Yes | - | A general service status code.
Example: RUNNING |
Interfaces: None
Encapsulates an Object UUID Id.
| Field | Type | Required? | Default | Description | Annotations |
|---|---|---|---|---|---|
| id | uuid | Yes | - | The tag services guid for this ObjectId.
|
|
| externalId | uuid | Yes | - | The external caller systems resource id for this Object.
|
|
| description | string | No | - | A short description of this object.
Minimum: 0 |
Interfaces: None
A slice of a set of objects.
| Field | Type | Required? | Default | Description | Annotations |
|---|---|---|---|---|---|
| slice | slice | Yes | - | The slice data for this slice.
|
|
| objects | [objectId] | Yes | - | A set of ObjectId's for this slice.
Maximum: 500 |
Interfaces: None
An cursor Slice for iterating through sets.
| Field | Type | Required? | Default | Description | Annotations |
|---|---|---|---|---|---|
| number | integer | Yes | - | The number of the current Slice.
|
|
| numberOfElements | integer | Yes | - | The number of elements currently on this Slice.
|
|
| size | integer | Yes | - | The size of this Slice.
|
|
| hasContent | boolean | Yes | - | Is there any content for this Slice.
|
|
| hasNext | boolean | Yes | - | Is there is a next Slice.
|
|
| hasPrevious | boolean | Yes | - | Is there is a previous Slice.
|
|
| isFirst | boolean | Yes | - | Is this the first Slice.
|
|
| isLast | boolean | Yes | - | Is this the last Slice.
|
Interfaces: None
A field and an order used to sort sets.
| Field | Type | Required? | Default | Description | Annotations |
|---|---|---|---|---|---|
| field | tagSortField | Yes | - | The field you want to sort on.
|
|
| order | sortOrder | Yes | - | The order you want to sort.
|
Interfaces: None
A tag.
| Field | Type | Required? | Default | Description | Annotations |
|---|---|---|---|---|---|
| id | uuid | Yes | - | A UUID string for this tag.
|
|
| value | string | Yes | - | The tag value
Minimum: 1 |
Interfaces: None
A form for creating a tag object.
| Field | Type | Required? | Default | Description | Annotations |
|---|---|---|---|---|---|
| value | string | Yes | - | The tag value
Minimum: 1 |
Marker for accessability fields/features, should trigger logging when empty or null
Marker for uri fields, add validation when possible
Marker for https only uris fields, add validation when possible
Marker for example field values, used for code generation of mocks, cdc, ect
Marked objects are considered case insensitive
Marked fields should be localized
Marked fields will get db indexes and apropriate repository methods
Marked models will get hibernate annotations
Marked model fields will be held unique
Marked model will use the snake case naming strategy for JsonNaming. This helps deal with outside apis.
