Skip to content

Commit 861483f

Browse files
oaldersrwstauner
authored andcommitted
Fixes formating problems. Links were displayed over other text.
Updated API docs (markdown)
1 parent 808c4d8 commit 861483f

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

docs/API-docs.md

+20-20
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,31 @@ The API itself is in its very early stages. Everything will change, but here ar
88

99
## Full text searching
1010

11-
###### First 10 modules with the word "RJBS" in the plain text Pod
11+
First 10 modules with the word "RJBS" in the plain text Pod
1212
[[http://api.metacpan.org/pod/_search?&fields=&q=text:rjbs&size=10]]
1313

1414
Note that this query returns no Pod fields because of the empty "fields" param.
1515

16-
###### First 10 modules with match on word fragment "RJB" in the plain text Pod
16+
First 10 modules with match on word fragment "RJB" in the plain text Pod
1717
[[http://api.metacpan.org/pod/_search?&fields=&q=text:*rjb*&size=10]]
1818

1919
Note that this query returns no Pod fields because of the empty "fields" param.
2020

21-
###### Text Pod for First 10 modules with the word "RJBS" in the Pod
21+
Text Pod for First 10 modules with the word "RJBS" in the Pod
2222
[[http://api.metacpan.org/pod/_search?&fields=_source.text&q=rjbs&size=10]]
2323

24-
###### HTML Pod for First 10 modules with the word "RJBS" in the Pod
24+
HTML Pod for First 10 modules with the word "RJBS" in the Pod
2525
[[http://api.metacpan.org/pod/_search?&fields=_source.html&q=rjbs&size=10]]
2626

2727
## Search for a Module
2828

29-
###### By name:
29+
By name:
3030
[[http://api.metacpan.org/module/Dancer::Cookbook]]
3131

32-
###### By distribution name:
32+
By distribution name:
3333
[[http://api.metacpan.org/module/_search?q=distname:moose]]
3434

35-
###### By author name:
35+
By author name:
3636

3737
Note that for this type of search, the author id must be in lower case.
3838

@@ -58,21 +58,21 @@ Using the "field" key, the search term becomes case-insensitive:
5858
}
5959
'</code></pre>
6060

61-
###### List all modules:
61+
List all modules:
6262
[[http://api.metacpan.org/module/_search?q=*&size=100000]]
6363

6464
Same list, but return only "name" and "distvname" fields:
6565
[[http://api.metacpan.org/module/_search?&fields=_source.distvname,_source.name&q=*&size=100000]]
6666

6767
## Search for a Distribution
6868

69-
###### By name:
69+
By name:
7070
[[http://api.metacpan.org/dist/Dancer]]
7171

72-
###### By distribution name:
72+
By distribution name:
7373
[[http://api.metacpan.org/dist/_search?q=name:dancer]]
7474

75-
###### By author name:
75+
By author name:
7676

7777
Note that for this type of search, the author id must be in lower case.
7878

@@ -98,39 +98,39 @@ Using the "field" key, the search term becomes case-insensitive:
9898
}
9999
'</code></pre>
100100

101-
###### List all distributions:
101+
List all distributions:
102102
[[http://api.metacpan.org/dist/_search?q=*&size=100000]]
103103

104104
Same list, but return only "name" and "distvname" fields:
105105
[[http://api.metacpan.org/dist/_search?&fields=_source.distvname,_source.name&q=*&size=100000]]
106106

107107
## Search for an author
108108

109-
###### By PAUSEID (exact match)
109+
By PAUSEID (exact match)
110110
[[http://api.metacpan.org/author/DROLSKY]]
111111

112-
###### By PAUSEID (wildcard match)
112+
By PAUSEID (wildcard match)
113113
[[http://api.metacpan.org/author/_search?q=author:D*]]
114114

115-
###### By name (find all Daves)
115+
By name (find all Daves)
116116
[[http://api.metacpan.org/author/_search?q=name:Dave]]
117117

118-
###### By full name
118+
By full name
119119
[[http://api.metacpan.org/author/_search?q=name:%22dave%20rolsky%22]]
120120

121-
###### List all authors
121+
List all authors
122122
[[http://api.metacpan.org/author/_search?pretty=true&q=*&size=100000]]
123123

124124
## Search for Pod
125125

126-
###### By module name (exact Match)
126+
By module name (exact Match)
127127
[[http://api.metacpan.org/pod/HTML::Restrict]]
128128

129129
## Search for CPANRatings ([[http://cpanratings.perl.org/]])
130130

131-
###### By distribution name (exact match)
131+
By distribution name (exact match)
132132
[[http://api.metacpan.org/cpanratings/Moose]]
133133

134-
###### By distribution name (find all rated Moose distros)
134+
By distribution name (find all rated Moose distros)
135135
[[http://api.metacpan.org/cpanratings/_search?q=dist:Moose]]
136136

0 commit comments

Comments
 (0)