Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

updating the example to be a little more clear

  • Loading branch information...
commit a3c84e1d827e13491e636124087365fc5e12aedd 1 parent 07f3f72
@caseysoftware authored
Showing with 68 additions and 35 deletions.
  1. +68 −35 README.md
View
103 README.md
@@ -75,54 +75,87 @@ DONE
Sample
----------------
-Results of: curl -X OPTIONS http://localhost/web2project-slim/links
+Results of: curl -X OPTIONS http://localhost/web2project-slim/projects
{
"actions": {
"create": {
- "href": "/web2project-slim/links",
- "method": "POST",
- "optional": [ "link_project", "link_url", "link_task", "link_name", "link_parent", "link_description", "link_owner", "link_date", "link_icon", "link_category" ],
- "required": [ "link_name", "link_url", "link_owner" ]
- },
+ "href": "/web2project-slim/projects",
+ "method": "POST",
+ "optional": [
+ "project_company", "project_name", "project_short_name", "project_owner",
+ "project_url", "project_demo_url", "project_start_date", "project_end_date",
+ "project_actual_end_date", "project_status", "project_percent_complete",
+ "project_color_identifier", "project_description", "project_target_budget",
+ "project_actual_budget", "project_scheduled_hours", "project_worked_hours",
+ "project_task_count", "project_creator", "project_active",
+ "project_private", "project_priority", "project_type", "project_parent",
+ "project_location", "project_original_parent", "project_departments",
+ "project_contacts"
+ ],
+ "required": [
+ "project_name", "project_short_name", "project_company",
+ "project_owner", "project_creator", "project_priority",
+ "project_color_identifier", "project_type", "project_status"
+ ]
+ },
"delete": {
- "href": "/web2project-slim/links:id",
- "method": "DELETE",
- "required": [ "link_id" ]
- },
+ "href": "/web2project-slim/projects:id",
+ "method": "DELETE",
+ "required": [
+ "project_id"
+ ]
+ },
"edit": {
- "href": "/web2project-slim/links:id",
- "method": "PATCH",
- "optional": [ "link_project", "link_url", "link_task", "link_name", "link_parent", "link_description", "link_owner", "link_date", "link_icon", "link_category" ],
+ "href": "/web2project-slim/projects/:id",
+ "method": "PATCH",
+ "optional": [
+ "project_company", "project_name", "project_short_name", "project_owner",
+ "project_url", "project_demo_url", "project_start_date", "project_end_date",
+ "project_actual_end_date", "project_status", "project_percent_complete",
+ "project_color_identifier", "project_description", "project_target_budget",
+ "project_actual_budget", "project_scheduled_hours", "project_worked_hours",
+ "project_task_count", "project_creator", "project_active",
+ "project_private", "project_priority", "project_type", "project_parent",
+ "project_location", "project_original_parent", "project_departments",
+ "project_contacts"
+ ],
"required": [
- "link_id"
+ "project_id"
]
- },
+ },
"filter": {
- "href": "/web2project-slim/links",
- "method": "GET",
- "optional": ["page", "limit"]
- },
+ "href": "/web2project-slim/projects",
+ "method": "GET",
+ "optional": [
+ "page",
+ "limit"
+ ]
+ },
"help": {
- "href": "/web2project-slim/links",
+ "href": "/web2project-slim/projects",
"method": "OPTIONS"
- },
+ },
"index": {
- "href": "/web2project-slim/links",
+ "href": "/web2project-slim/projects",
"method": "GET"
- },
+ },
"search": {
- "href": "/web2project-slim/links",
- "method": "GET",
- "required": [ "search" ]
- },
+ "href": "/web2project-slim/projects",
+ "method": "GET",
+ "required": [
+ "search"
+ ]
+ },
"view": {
- "href": "/web2project-slim/links:id",
- "method": "GET",
- "required": [ "link_id" ]
+ "href": "/web2project-slim/projects/:id",
+ "method": "GET",
+ "required": [
+ "project_id"
+ ]
}
- },
- "resource_uri": "/links",
- "root_uri": "/web2project-slim",
- "self": "/web2project-slim/links"
-}
+ },
+ "resource_uri": "/projects",
+ "root_uri": "/web2project-slim",
+ "self": "/web2project-slim/projects"
+}

0 comments on commit a3c84e1

Please sign in to comment.
Something went wrong with that request. Please try again.