Skip to content

Commit 5eaa3f0

Browse files
shprinkshprink
committed
docs
1 parent 50825d4 commit 5eaa3f0

5 files changed

Lines changed: 111 additions & 143 deletions

File tree

‎README.md‎

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,15 @@ If you want to use AngularJS v1, here is the latest version: [v2.0.0-rc3](https:
77

88
## Installation
99

10-
### npm
10+
### Prerequisite
11+
12+
make sure you have those packages installed too:
13+
14+
- '@angular/core'
15+
- 'rxjs'
16+
- '@angular/http'
17+
18+
### via npm
1119

1220
```
1321
npm install wp-api-angularjs@v3.0.x
@@ -34,6 +42,41 @@ bootstrap(App, [
3442
3543
```
3644

45+
## API
46+
47+
48+
### IWpApiPosts
49+
50+
```
51+
getList(options?: RequestOptionsArgs): Observable<Response>;
52+
get(postId, options?: RequestOptionsArgs): Observable<Response>;
53+
create(body: any, options?: RequestOptionsArgs): Observable<Response>;
54+
update(postId, body: any, options?: RequestOptionsArgs): Observable<Response>;
55+
delete(postId, options?: RequestOptionsArgs): Observable<Response>;
56+
getMetaList(postId, options?: RequestOptionsArgs): Observable<Response>;
57+
getMeta(postId, metaId, options?: RequestOptionsArgs): Observable<Response>;
58+
getRevisionList(postId, options?: RequestOptionsArgs): Observable<Response>;
59+
getRevision(postId, revisionId, options?: RequestOptionsArgs): Observable<Response>;
60+
getCategoryList(postId, options?: RequestOptionsArgs): Observable<Response>;
61+
getCategory(postId, categoryId, options?: RequestOptionsArgs): Observable<Response>;
62+
getTagList(postId, options?: RequestOptionsArgs): Observable<Response>;
63+
getTag(postId, tagId, options?: RequestOptionsArgs): Observable<Response>;
64+
```
65+
66+
### IWpApiPages
67+
68+
```
69+
getList(options?: RequestOptionsArgs): Observable<Response>;
70+
get(postId, options?: RequestOptionsArgs): Observable<Response>;
71+
create(body: any, options?: RequestOptionsArgs): Observable<Response>;
72+
update(postId, body: any, options?: RequestOptionsArgs): Observable<Response>;
73+
delete(postId, options?: RequestOptionsArgs): Observable<Response>;
74+
getMetaList(postId, options?: RequestOptionsArgs): Observable<Response>;
75+
getMeta(postId, metaId, options?: RequestOptionsArgs): Observable<Response>;
76+
getRevisionList(postId, options?: RequestOptionsArgs): Observable<Response>;
77+
getRevision(postId, revisionId, options?: RequestOptionsArgs): Observable<Response>;
78+
```
79+
3780
## Authentication
3881

3982
TO BE DEFINED

‎bower.json‎

Lines changed: 0 additions & 14 deletions
This file was deleted.

‎config.dist.json‎

Lines changed: 65 additions & 126 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,11 @@
11
{
22
"baseUrl": "http://sandbox.YourDomain.com/wp-json",
3-
"basic": {
4-
"enabled": false,
5-
"login": null,
6-
"password": null
7-
},
8-
"customMethods": {
9-
"entityName": {
10-
"getList": [{
11-
"per_page": 1
12-
}],
13-
"get": [295],
14-
"create": [{
15-
"title": "Custom Post Title"
16-
}],
17-
"update": [295, {
18-
"title": "New Custom Post Title"
19-
}],
20-
"delete": []
21-
}
22-
},
23-
"postsMethods": {
3+
"api" : {
4+
"wpApiPosts": {
245
"getList": [{
256
"per_page": 1
267
}],
278
"get": [2016],
28-
"create": [{
29-
"title": "Post Title"
30-
}],
31-
"update": [2016, {
32-
"title": "New Post Title"
33-
}],
34-
"delete": [],
359
"getMetaList": [2016],
3610
"getMeta": [2016, 46575],
3711
"getRevisionList": [2016],
@@ -40,103 +14,68 @@
4014
"getCategory": [2016, 86],
4115
"getTagList": [2016],
4216
"getTag": [2016, 87]
43-
},
44-
"pagesMethods": {
45-
"getList": [{
46-
"per_page": 1
47-
}],
48-
"get": [535],
49-
"create": [{
50-
"title": "Page Title"
51-
}],
52-
"update": [535, {
53-
"title": "New Page Title"
54-
}],
55-
"delete": [],
56-
"getMetaList": [535],
57-
"getMeta": [535, 1],
58-
"getRevisionList": [535],
59-
"getRevision": [535, 2035]
60-
},
61-
"mediaMethods": {
62-
"getList": [{
63-
"per_page": 1
64-
}],
65-
"get": [2032],
66-
"create": [{
67-
"title": "Media Title"
68-
}],
69-
"update": [2032, {
70-
"title": "New Media Title"
71-
}],
72-
"delete": []
73-
},
74-
"typesMethods": {
75-
"getList": [{
76-
"per_page": 1
77-
}],
78-
"get": ["attachment"]
79-
},
80-
"statusesMethods": {
81-
"getList": [],
82-
"get": ["publish"]
83-
},
84-
"taxonomiesMethods": {
85-
"getList": [],
86-
"get": ["category"]
87-
},
88-
"termsMethods": {
89-
"getCategoryList": [],
90-
"getCategory": [86],
91-
"createCategory": [{
92-
"name": "Category Name"
93-
}],
94-
"updateCategory": [86, {
95-
"name": "New Category Name"
96-
}],
97-
"deleteCategory": [],
98-
"getTagList": [],
99-
"getTag": [59],
100-
"createTag": [{
101-
"name": "Tag Name"
102-
}],
103-
"updateTag": [59, {
104-
"name": "New Tag Name"
105-
}],
106-
"deleteTag": [],
107-
"getCustomList": ["audience"],
108-
"getCustom": ["audience", 6],
109-
"createCustom": ["audience", {
110-
"name": "Term Name"
111-
}],
112-
"updateCustom": ["audience", 6, {
113-
"name": "New Term Name"
114-
}],
115-
"deleteCustom": ["audience"]
116-
},
117-
"usersMethods": {
118-
"getList": [],
119-
"get": [1],
120-
"create": [{
121-
"username": "adminuser",
122-
"email": "admin@domain.com",
123-
"password": "wordpress"
124-
}],
125-
"update": [1, {
126-
"email": "newadmin@domain.com"
127-
}],
128-
"delete": [],
129-
"me": []
130-
},
131-
"commentsMethods": {
132-
"getList": [],
133-
"get": [686],
134-
"create": [{
135-
"comment": "Hello, World!"
136-
}],
137-
"update": [686, {
138-
"comment": "Foo Bar"
139-
}],
140-
"delete": []
17+
},
18+
"customMethods": {
19+
"movie": {
20+
"getList": [{
21+
"per_page": 1
22+
}],
23+
"get": [295]
24+
},
25+
"plane": {
26+
"getList": [{
27+
"per_page": 1
28+
}],
29+
"get": [295]
30+
}
31+
},
32+
"wpApiPages": {
33+
"getList": [{
34+
"per_page": 1
35+
}],
36+
"get": [535],
37+
"getMetaList": [535],
38+
"getMeta": [535, 1],
39+
"getRevisionList": [535],
40+
"getRevision": [535, 2035]
41+
},
42+
"mediaMethods": {
43+
"getList": [{
44+
"per_page": 1
45+
}],
46+
"get": [2032]
47+
},
48+
"typesMethods": {
49+
"getList": [{
50+
"per_page": 1
51+
}],
52+
"get": ["attachment"]
53+
},
54+
"statusesMethods": {
55+
"getList": [],
56+
"get": ["publish"]
57+
},
58+
"taxonomiesMethods": {
59+
"getList": [],
60+
"get": ["category"]
61+
},
62+
"termsMethods": {
63+
"getCategoryList": [],
64+
"getCategory": [2],
65+
"getTagList": [],
66+
"getTag": [11],
67+
"getCustomList": ["audience"],
68+
"getCustom": ["audience", 6]
69+
},
70+
"usersMethods": {
71+
"getList": [],
72+
"get": [1],
73+
"me": []
74+
},
75+
"commentsMethods": {
76+
"getList": [],
77+
"get": [686]
78+
}
14179
}
80+
14281
}

‎dist/wp-api-angularjs.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)