Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

APIDocs - description editable pls #4

Closed
chrisv opened this issue Jun 27, 2014 · 5 comments
Closed

APIDocs - description editable pls #4

chrisv opened this issue Jun 27, 2014 · 5 comments
Assignees
@khrt
Labels
enhancement

Comments

@chrisv
Copy link

chrisv commented Jun 27, 2014

The "description" of an API should preferably be editable. Now it's just hardcoded to say "Operations about " (see line 101 in APIDocs.pm).

Many thanks in advance for making this configurable per in a future release.
@chrisv
Copy link
Author

chrisv commented Jun 27, 2014

Also please allow for changing the description per parameter as it now it defaults to PARAMETER DESCRIPTION

@khrt
Copy link
Owner

khrt commented Jun 27, 2014

I'm going to do descriptions for routes in next release.

But I can't say so about the description of a parameter. Because if I going to do this feature I'll have to once again break compatibility with the previous version. Because I'm thinking of declaring parameters as hashref instead of arrayref.

khrt pushed a commit that referenced this issue Jul 15, 2014
API docs parameters description #4
ccd5bba 
    * Update base example;
    * Update route_param in API;
khrt pushed a commit that referenced this issue Jul 15, 2014
DRAFT API docs parameters description #4
161a7b6 
    * NEW `desc` keyword;
@khrt
Copy link
Owner

khrt commented Jul 17, 2014

Now you could add description to yours operations and parameters.

Still working on the initial request.

@khrt khrt self-assigned this Jul 17, 2014
khrt pushed a commit that referenced this issue Jul 17, 2014
Description for resources #4
5788782 
    * Raisin: `add_resource_desc`, `resource_desc`;
    * API: `_add_route`;
    * APIDocs;
    * Update example and POD;
@khrt
Copy link
Owner

khrt commented Jul 17, 2014

You can add description for resource like in this example:

desc 'Actions on users',
resource => 'user' => sub { ... }

See example.

@khrt khrt closed this as completed Jul 17, 2014
@chrisv
Copy link
Author

chrisv commented Jul 24, 2014

Many thanks for adding this feature!

@khrt khrt assigned khrt and unassigned khrt Oct 7, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@khrt khrt

Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@chrisv @khrt