Resources Enums Models Annotations Clients

bml-gen-test-application 0.0.2

History | Watch
  • Contact: N/A
  • License: N/A

Resources

account

Operations

Method and Path Description
POST /accounts
GET /accounts/:id
GET /accounts/:id/foo

A mock to test returning a raw array. This is not a practical method to implement in a production environment. In production you would return a page object but here we want to test to ensure generators are handling raw array return value.
GET /accounts

A mock to test returning a raw array. This is not a practical method to implement in a production environment. In production you would return a page object but here we want to test to ensure generators are handling raw array return value.
DELETE /accounts/:id

Delete an Account resource by id.

Headers

No headers

Imports

http://api.apibuilder.io/bml/annotation/0.0.1/service.json
http://api.apibuilder.io/bml/validation/0.0.1/service.json

Enums

test_enumeration

Test Enumeration provides a useful test for enumeration based code generation.

Name Value Description
foo foo

A foo enumeration entry.
bar bar

A bar enumeration entry.

Interfaces

No interfaces

Models

account

Example Json: Minimal | Full

Interfaces: None

This is the top level in the system. It represents a specific client.

Field Type Required? Default Description Annotations
id uuid Yes -

The Universally Unique Identifier. See RFC 4122.
awsAccount string Yes -

Test param for a pattern restricted string.

Minimum: 1
Maximum: 255
name string Yes -

A unique human readable string name.

Minimum: 1
Maximum: 255
Example: Universal Remonster Ltd
enabled boolean Yes -

Adds the ability to enable / disable this resource.

account_form

Example Json: Minimal | Full

Interfaces: None

A form used for creating an Account resource.

Field Type Required? Default Description Annotations
name string Yes -

A unique human readable string name.

Minimum: 1
Maximum: 255
Example: Universal Remonster Ltd.
enabled boolean Yes -

Adds the ability to enable / disable this resource.

client

Example Json: Minimal | Full

Interfaces: None

A model client for testing generation.

Field Type Required? Default Description Annotations
accounts [account] Yes -

test field to make sure non empty lists are non empty in generated mock factories.

Maximum: 3

healthcheck

Example Json: Minimal | Full

Interfaces: None

A response model for the standard health check resource.

Field Type Required? Default Description Annotations
status string Yes -

A general status string.

Minimum: 1
Maximum: 1024
Example: healthy

Unions

No unions

Annotations

accessibility

Marker for accessability fields/features, should trigger logging when empty or null

uri

Marker for uri fields, add validation when possible

httpsUri

Marker for https only uris fields, add validation when possible

example

Marker for example field values, used for code generation of mocks, cdc, ect

caseSensitive

Marked objects are considered case insensitive

localized

Marked fields should be localized

index

Marked fields will get db indexes and apropriate repository methods

hibernate

Marked models will get hibernate annotations

unique

Marked model fields will be held unique

snakeCaseStrategy

Marked model will use the snake case naming strategy for JsonNaming. This helps deal with outside apis.