sealcode / sealious

An extensible, declarative node framework
25 stars 2 forks source link

Issue#217 get signature #218

Closed arkadiusz-wieczorek closed 8 years ago

arkadiusz-wieczorek commented 9 years ago

It's example for returned response on request to /api/v1/description

[
    {
        "name": "user",
        "human_readable_name": "User",
        "human_readable_description": "This resource type was created for handling users, it allows users to set up accounts. After creating an account, the user will be able to login to the your application.",
        "body": {
            "username": {
                "name": "username",
                "type_name": "text",
                "human_readable_name": {},
                "type": {
                    "params": {}
                },
                "required": true,
                "derived": false
            },
            "email": {
                "name": "email",
                "type_name": "email",
                "human_readable_name": {},
                "type": {
                    "params": {}
                },
                "required": false,
                "derived": false
            },
            "password": {
                "name": "password",
                "type_name": "text",
                "human_readable_name": {},
                "type": {
                    "params": {}
                },
                "required": true,
                "derived": false
            },
            "status": {
                "name": "status",
                "type_name": "text",
                "human_readable_name": {},
                "type": {
                    "params": {}
                },
                "required": false,
                "derived": false
            }
        }
    }
]
arkadiusz-wieczorek commented 9 years ago

I simplified response body.

[
    {
        "name": "user",
        "human_readable_name": "User",
        "human_readable_description": "This resource type was created for handling users, it allows users to set up accounts. After creating an account, the user will be able to login to the your application.",
        "body": {
            "0": {
                "name": "username",
                "type": "text",
                "required": true,
                "params": {}
            },
            "1": {
                "name": "email",
                "type": "email",
                "required": false,
                "params": {}
            },
            "2": {
                "name": "password",
                "type": "text",
                "required": true,
                "params": {}
            },
            "3": {
                "name": "status",
                "type": "text",
                "required": false,
                "params": {}
            }
        }
    }
]
kuba-orlik commented 9 years ago

"fields" should be a hashmap (field_name->field_description)

arkadiusz-wieczorek commented 9 years ago

I added changes.

[
    {
        "name": "user",
        "human_readable_name": "User",
        "summary": "This resource type was created for handling users, it allows users to set up accounts. After creating an account, the user will be able to login to the your application.",
        "fields": {
            "username": {
                "name": "username",
                "type": "text",
                "required": true,
                "params": {}
            },
            "email": {
                "name": "email",
                "type": "email",
                "required": false,
                "params": {}
            },
            "password": {
                "name": "password",
                "type": "text",
                "required": true,
                "params": {}
            },
            "status": {
                "name": "status",
                "type": "text",
                "required": false,
                "params": {}
            }
        }
    }
]
arkadiusz-wieczorek commented 8 years ago

I must add required information to documentation.