{{ metadata.projectName }}

Created by {{ metadata.fileAuthor }} on {{ metadata.pubDate }} via Erlenmeyer.
Copyright © {{ metadata.pubYear }} {{ metadata.projectOwner }}. All rights reserved.

{% for model in models %}

{{ model.className }}

GET /{{ model.className }}s

Parameters:

None

Responses:

200 - OK 
[
    {
        {%- for attribute in model.attributes %}
        "{{ attribute.name }}": {{ attribute.exampleValue }}
        {%- endfor -%}
        {%- for relationship in model.relationships if not relationship.isToMany %}
        "{{ relationship.name }}": {{ relationship.exampleValue }}
        {%- endfor %}
    }
]

PUT /{{ model.className }}s

Parameters:

{% for attribute in model.attributes %} {% endfor %} {% for relationship in model.relationships if not relationship.isToMany %} {% endfor %}
Name Type
{{ attribute.name }} {{ attribute.type }}
{{ relationship.name }} {{ relationship.type }}

Responses:

200 - OK

GET /{{ model.className }}s/<{{ model.primaryKey }}>

Parameters:

Name Type
{{ model.primaryKey }} {{ model.primaryKeyType }}

Responses:

200 - OK 
{
    {%- for attribute in model.attributes %}
    "{{ attribute.name }}": {{ attribute.exampleValue }}
    {%- endfor -%}
    {% for relationship in model.relationships if not relationship.isToMany %}
    "{{ relationship.name }}": {{ relationship.exampleValue }}
    {%- endfor %}
}
404 - Not Found

POST /{{ model.className }}s/<{{ model.primaryKey }}>

Parameters:

{% for attribute in model.attributes %} {% endfor %} {% for relationship in model.relationships if not relationship.isToMany %} {% endfor %}
Name Type
{{ attribute.name }} {{ attribute.type }}
{{ relationship.name }} {{ relationship.type }}

Responses:

200 - OK
404 - Not Found

DELETE /{{ model.className }}s/<{{ model.primaryKey }}>

Parameters:

Name Type
{{ model.primaryKey }} {{ model.primaryKeyType }}

Responses:

200 - OK
404 - Not Found
{% for relationship in model.relationships %} {% if relationship.isToMany %}

GET /{{ model.className }}s/<{{ model.primaryKey }}>/{{ relationship.name }}

Parameters:

Name Type
{{ model.primaryKey }} {{ model.primaryKeyType }}

Responses:

200 - OK
{% for model in models if model.className == relationship.className %} 
[
    {
        {%- for attribute in model.attributes %}
        "{{ attribute.name }}": {{ attribute.exampleValue }}
        {%- endfor -%}
        {% for relationship in model.relationships if not relationship.isToMany %}
        "{{ relationship.name }}": {{ relationship.exampleValue }}
        {%- endfor %}
    }
]
{% endfor %}
404 - Not Found

PUT /{{ model.className }}s/<{{ model.primaryKey }}>/{{ relationship.name }}

Parameters:

Name Type
{{ model.primaryKey }} {{ model.primaryKeyType }}
{{ relationship.name }}Object {{ model.primaryKeyType }}

Responses:

200 - OK
400 - {{ relationship.name }}Object Invalid
404 - Not Found

DELETE /{{ model.className }}s/<{{ model.primaryKey }}>/{{ relationship.name }}

Parameters:

Name Type
{{ model.primaryKey }} {{ model.primaryKeyType }}
{{ relationship.name }}Object {{ model.primaryKeyType }}

Responses:

200 - OK
400 - {{ relationship.name }}Object Invalid
404 - Not Found
{% else %}

GET /{{ model.className }}s/<{{ model.primaryKey }}>/{{ relationship.name }}

Parameters:

Name Type
{{ model.primaryKey }} {{ model.primaryKeyType }}

Responses:

200 - OK
{% for model in models if model.className == relationship.className %} 
{
    {%- for attribute in model.attributes %}
    "{{ attribute.name }}": {{ attribute.exampleValue }}
    {%- endfor -%}
    {% for relationship in model.relationships if not relationship.isToMany %}
    "{{ relationship.name }}": {{ relationship.exampleValue }}
    {%- endfor %}
}
{% endfor %}
404 - Not Found

POST /{{ model.className }}s/<{{ model.primaryKey }}>/{{ relationship.name }}

Parameters:

Name Type
{{ model.primaryKey }} {{ model.primaryKeyType }}
{{ relationship.name }}Object {{ model.primaryKeyType }}

Responses:

200 - OK
400 - {{ relationship.name }}Object Invalid
404 - Not Found
{% endif %} {% endfor %}
{% endfor %}