Skip to content

Commit 0b6475f

Browse files
authored
Fixed a small number of missed instances (circleci#259)
Also fixed a couple broken headers
1 parent 07ad7aa commit 0b6475f

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

jekyll/_docs/api.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -132,11 +132,11 @@ All CircleCI API endpoints begin with `"https://circleci.com/api/v1.1/"`.
132132

133133
1. Add an API token from your [account dashboard](https://circleci.com/account/api).
134134
2. To test it,
135-
[View it in your browser](https://circleci.com/api/v1/me)
135+
[View it in your browser](https://circleci.com/api/v1.1/me)
136136
or call the API using `curl`:
137137

138138
```
139-
$ curl https://circleci.com/api/v1/me?circle-token=:token
139+
$ curl https://circleci.com/api/v1.1/me?circle-token=:token
140140
```
141141

142142
3. You should see a response like the following:
@@ -156,27 +156,25 @@ $ curl https://circleci.com/api/v1/me?circle-token=:token
156156
<h2 id="calling">Making calls</h2>
157157

158158
All API calls are made in the same way, by making standard HTTP calls, using JSON, a content-type, and your API token.
159-
All CircleCI API endpoints begin with `"https://circleci.com/api/v1/"`.
159+
All CircleCI API endpoints begin with `"https://circleci.com/api/v1.1/"`.
160160

161161
## Authentication
162162

163163
To authenticate, add an API token using your [account dashboard](https://circleci.com/account/api). To use the API token, add it to the
164164
`circle-token` query param, like so:
165165

166166
```
167-
curl https://circleci.com/api/v1/me?circle-token=:token
167+
curl https://circleci.com/api/v1.1/me?circle-token=:token
168168
```
169-
##
170-
Version Control System (:vcs-type)
169+
## Version Control System (:vcs-type)
171170

172171
New with v1.1 of the api, for endpoints under /project you will now need to tell CircleCi what version control system type your project uses. Current choices are 'github' or 'bitbucket'. The command for recent builds for a project would be formatted like so:
173172

174173
```
175174
curl https://circleci.com/api/v1.1/project/:vcs-type/:username/:project/tree/:branch
176175
```
177176

178-
##
179-
F/OSS
177+
## F/OSS
180178

181179
If you have a Free / Open Source Software ([F/OSS](https://www.gnu.org/philosophy/free-sw.html)) project, and have the setting turned on in Advanced Settings in your project dashboard, some read-only /project endpoints will return the requested data without the need for a token. People will also be able to view the build results dashboard for the project as well.
182180

0 commit comments

Comments
 (0)