Commit Graph

235 Commits

Author SHA1 Message Date
Achilleas Pipinellis 47c9b7d34c Update CI API docs
- Move ci/api under api/ci
- Clean up builds.md and runners.md
- Replace old links with new ones
- Add CI API links in ci/README.md
2016-06-14 14:47:32 +02:00
Timothy Andrew ae0d8222af Merge remote-tracking branch 'origin/master' into 2979-personal-access-tokens 2016-06-03 09:31:16 +05:30
Rémy Coutable f7bdbc0b55
Make it clearer that /licenses is the OS license templates endpoint
Signed-off-by: Rémy Coutable <remy@rymai.me>
2016-05-18 00:07:51 -05:00
Timothy Andrew d915e7d5ca Reuse the private token param and header for personal access tokens.
- https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/3749#note_11626427
- Personal access tokens are still a separate entity as far as the
  codebase is concerned - they just happen to use the same entry point
  as private tokens.
- Update tests and documentation to reflect this change
2016-05-11 10:16:23 +05:30
Timothy Andrew 2768e99ac3 Add documentation for personal access tokens. 2016-04-28 22:28:36 +05:30
Rémy Coutable 13804aba86 Continue implementation of the license template selector and /licenses API endpoint
Signed-off-by: Rémy Coutable <remy@rymai.me>
2016-04-18 14:47:50 +02:00
Robert Schilling ea2193aaeb API: Star and unstar a project 2016-04-13 14:26:40 +02:00
Tomasz Maczukin 43c8daf3dc Add runners API documentation [ci-skip] 2016-02-19 13:18:46 +01:00
Achilleas Pipinellis 84354b4bd2 Fix typos, grammar and other styleguide issues
[ci skip]
2016-01-18 21:49:04 +01:00
Achilleas Pipinellis 2ffc438efb Use plaintext instead of json in code blocks
[ci skip]
2016-01-18 11:45:04 +01:00
Achilleas Pipinellis 958dd27777 Clean-up API README [ci skip]
- Fix some curl examples
- Fix examples for id vs iid
2016-01-18 11:38:54 +01:00
Achilleas Pipinellis 415b78e07c Merge branch 'master' into doc_refactor_README_api 2016-01-18 11:04:39 +01:00
Achilleas Pipinellis 23b4d31def Merge branch 'rc-document-new-api-pagination-headers' into 'master'
Document new API pagination headers

Document new API pagination headers introduced in !2426. Solves #8098.

/cc @dzaporozhets @dblessing

See merge request !2435
2016-01-18 10:00:50 +00:00
Achilleas Pipinellis 4a76f9217a Clean up pagination documentation [ci skip]
- Fix heading names
- Fix curl example
- Use full request output
- Use table for the extra headers
2016-01-18 10:55:25 +01:00
Achilleas Pipinellis 60752b6ec8 Refactor README API documentation [ci skip] 2016-01-18 10:10:33 +01:00
Tomasz Maczukin 768721dc58 Merge branch 'master' into ci/api-triggers
* master: (150 commits)
  fixes margin and padding
  Update mailroom/postfix documentation [ci skip]
  Fix css mess around git clone panel. Align it properly
  Fix missing padding for user/group pages
  Fix parse_gollum_tags matcher
  Update documentation on Banzai::Filter::GollumTagsFilter
  Add tests for the wiki pipeline
  Refactoring Banzai::Filter::GollumTagsFilter
  Make sure the .git is at the end on Gitlab::GithubImport::WikiFormatter
  Remove GollumTagsPipeline
  Refactoring Gitlab::GithubImport::Importer
  Remove unnecessary brackets on WIKI_SLUG_ID route constraints
  Move js function to removing accents to vendor/assets/javascripts
  Update CHANGELOG
  Use the WikiPipeline when rendering the wiki markdown content
  Add Banzai::Filter::GollumTagsFilter for parsing Gollum's tags in HTML
  Relax constraints for wiki slug
  Import GitHub wiki into GitLab
  Move Ci::Build#available_statuses to AVAILABLE_STATUSES constant in CommitStatus
  Revert changes to how the notes are paginated in the API
  ...

Conflicts:
	doc/api/README.md
	lib/api/entities.rb
2016-01-14 21:58:17 +01:00
Rémy Coutable 8026d420c9 Document new API pagination headers 2016-01-14 17:14:20 +01:00
Tomasz Maczukin 405b82af23 Merge branch 'master' into ci/api-builds
* master: (51 commits)
  Fix version
  Fix specs and rubocop warnings
  Improve the consistency of commit titles, branch names, tag names, issue/MR titles, on their respective project pages
  fixed LDAP activation on login to use new ldap_blocked state
  Fix Admin/Users view to position buttons without spacing magic
  Update to Go 1.5.3
  Fix the undefinded variable error in Project's safe_import_url method
  Update CHANGELOG [ci skip]
  Add some cosmetic changes to variables API documentation [ci skip]
  Fix misaligned edit button in milestone collection partial
  Update button styles for Milestones#show
  Modify builds API documentation style [ci skip]
  Modify :ci_variable factory
  Ensure the API doesn't return notes that the current user shouldn't see
  Add 'Build' prefix to Variables entry name in API docs index
  Fix some typos
  Add spec for Note#cross_reference_not_visible_for?
  Remove (invalid) timestamp formatting
  Move `BroadcastMessage#status` to a helper since it's presentational
  Update CHANGELOG
  ...

Conflicts:
	doc/api/README.md
	lib/api/api.rb
	lib/api/entities.rb
2016-01-14 13:30:18 +01:00
Tomasz Maczukin af3b97cdde Merge branch 'master' into ci/api-triggers
* master:
  Fix version
  Improve the consistency of commit titles, branch names, tag names, issue/MR titles, on their respective project pages
  Update CHANGELOG [ci skip]
  Add some cosmetic changes to variables API documentation [ci skip]
  Modify builds API documentation style [ci skip]
  Modify :ci_variable factory
  Add 'Build' prefix to Variables entry name in API docs index
  Fix some typos
  Add some fixes after review
  Remove blank line
  Update ./doc/api
  Change :variable_id to :key as resource ID in API
  Fix a typo in method description
  Add create feature to variables API
  Add missing 'not_found' checks in variables API
  Add delete feature to variables API
  Add update feature for variables API
  Add features for list and show details of variables in API

Conflicts:
	doc/api/README.md
	lib/api/entities.rb
2016-01-14 13:09:54 +01:00
Tomasz Maczukin 633ac13404 Modify triggers API documentation style [ci skip] 2016-01-14 10:57:56 +01:00
Tomasz Maczukin d338087605 Add 'Build' prefix to Variables entry name in API docs index 2016-01-13 18:51:27 +01:00
Tomasz Maczukin b604459068 Update ./doc/api 2016-01-07 14:10:49 +01:00
Tomasz Maczukin b0a77a2248 Update ./doc/api 2016-01-07 11:04:25 +01:00
Tomasz Maczukin a862ade55b Update ./doc/api/ 2016-01-05 16:36:14 +01:00
Robert Schilling ca735446ef Add tags page to readme [ci skip] 2015-11-21 12:13:30 +01:00
Artem V. Navrotskiy 1be79e8e7c Move get user by ID of an SSH key documentation to separate file 2015-09-03 16:32:26 +03:00
Sytse Sijbrandij b2246ed175 Make sure webhooks are mentioned at the top level. 2015-07-08 22:27:36 +02:00
Dmitriy Zaporozhets b28714b6a9
Add docs and empty specs for applicaiton settings API
Signed-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>
2015-07-06 15:53:08 +02:00
Stan Hu 67992b9be6 Make namespace API available to all users
Closes https://github.com/gitlabhq/gitlabhq/issues/9328
2015-05-28 11:39:12 -07:00
Kevin Lyda 644a8437d0 Add link to services api doc. 2015-04-20 10:31:18 +01:00
Sytse Sijbrandij 10e4e2110c Improve the explanation and linking of the Oauth docs. 2015-02-18 20:49:19 -08:00
Ewan Edwards e6e337088b Make all non-config/non-operational mentions of URL consistently
capitalized.

Make the plural version consistently "URLs".

Fix an instance where the article "the" before URL was missing.
2015-01-30 10:24:45 -08:00
Valery Sizov f07b165ab7 OAuth API documentation update 2015-01-12 19:29:06 -08:00
Job van der Voort 6704792933 link third applications to website 2014-10-23 11:11:53 +02:00
jubianchi 998cd3cb63 Improve error reporting on users API
* users (#6878, #3526, #4209): Validation error messages are now exposed through 400 responses, 409 response are sent in case of duplicate email or username
* MRs (#5335): 409 responses are sent in case of duplicate merge request (source/target branches), 422 responses are sent when submiting MR fo/from unrelated forks
* issues
* labels
* projects
2014-09-16 01:25:24 +02:00
James Brooks 3f36f84c1f Consistency, spelling and grammar 2014-08-15 15:03:01 +01:00
Robert Schilling 9284038dbe Add, delete labels via API 2014-08-13 12:28:19 +02:00
Robert Schilling abdc442648 Fix spelling errors in doc, closes #7437
Further changes
2014-08-07 10:27:54 +02:00
Ciro Santilli fd348de76d Update docs to markdown style guide. 2014-06-03 23:16:31 +02:00
Scooletz d7cee6ed76 .NET client introduced to docs 2014-05-17 00:04:09 +02:00
Dmitriy Zaporozhets 1ba865c6a6 Merge branch 'master' into 'master'
Added Laravel API Wrapper
2014-05-08 18:21:49 +00:00
dosire 5bf12bbb1d Make clear that notes also serve as comments. 2014-04-30 17:28:05 +02:00
Manfred Touron 274d6db187 Added Node.js library link 2014-04-28 22:20:33 +02:00
Adam Engebretson ccdf7a329a Added Laravel API Wrapper 2014-04-25 03:38:54 +00:00
dosire b2b2989f7f Endpoints are for RPC interfaces, we have resources. 2014-04-15 14:52:02 +02:00
Dmitriy Zaporozhets 83941ca208 Merge branch 'pagination-link-header-doc' into 'master'
Pagination-link-header-doc
2014-03-31 16:04:28 +00:00
Dmitriy Zaporozhets 8f3701eff0
Move branches API docs to separate file
Signed-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>
2014-03-31 16:43:45 +03:00
dosire 24f64e65a6 Add documentation for https://github.com/gitlabhq/gitlabhq/pull/5469 2014-03-31 13:16:52 +02:00
dosire b04c343311 Put important information at the top of the readme. 2014-03-27 10:53:26 +01:00
Dmitriy Zaporozhets 6cf39fe10d
Extract commits API to separate file
Signed-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>
2014-02-18 12:41:21 +02:00
Dmitriy Zaporozhets ddbe978041
Complete api files CRUD
Signed-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>
2014-02-18 12:27:02 +02:00
Dmitriy Zaporozhets 02693b72a4 Explain iid in API 2013-10-14 16:40:16 +03:00
Marin Jankovski d7ec7c794a Removed user teams api docs. 2013-10-02 12:51:43 +02:00
Izaak Alpert e86e881832 API: admin users can sudo commands as other users
-Specifying a header of SUDO or adding a :sudo with either user id, or username of the user will set the current_user to be that user if your identifying private_token/PRIVATE_TOKEN is an administrator token
2013-09-09 12:04:38 -04:00
MegaDiablo 90af8aa6fe add link on realisation api for java client 2013-08-20 14:35:49 +03:00
Itxaka Serrano bc3a4d3194 added python api wrapper 2013-08-07 09:40:26 +02:00
TJ Biddle 4261a5a1ea Adding links to the merge requests and group documentation. 2013-07-26 07:53:35 -07:00
Sean Zicari 87e8c2dc3d Update README.md
Updated the relative links in ## Contents to point to the correct documents.
2013-07-17 13:51:12 -07:00
Robert Schilling 4de11c2009 Fix broken API links, fixes #4463 2013-07-07 12:35:37 +02:00
Matt Humphrey 4bba945437 Added client list to API doc 2013-07-06 10:14:06 +01:00
Greg Barendt ad0f1276db Fix paths to the Contents Markdown pages 2013-06-11 11:36:54 -03:00
Dmitriy Zaporozhets beb0adf202 Fix api readme links 2013-06-06 15:40:26 +03:00
Dmitriy Zaporozhets c3ba0ee64b Merge branch 'feature_teams_api' of https://github.com/former03/gitlabhq into former03-feature_teams_api
Conflicts:
	doc/api/README.md
2013-05-27 15:05:01 +03:00
Ben Bodenmiller 603720e3aa remove branch dependencies where not necessary 2013-05-27 00:32:58 -07:00
Christian Simon 0ebfa5e5a2 [FEATURE] Basic user_teams api
* Closing #3066
 * Closing #3609
2013-05-21 23:13:30 +02:00
Matt Humphrey 7fb2999c60 Added system hooks link to doc index 2013-03-08 09:37:00 +00:00
Sebastian Ziebell 3374027e3a Merge branch 'master' into fixes/api, code clean up and tests fixed
Conflicts:
	doc/api/projects.md
	spec/requests/api/projects_spec.rb
2013-03-07 14:51:56 +01:00
Sebastian Ziebell 39114d259c API: documentation contains infos to status codes in README file.
All the info to return codes from the API functions are available in the `README.md` file as suggested.
2013-03-07 00:15:57 +01:00
Sebastian Ziebell 43d7596030 Merge branch 'feature/api-documentation-fixes' of github.com:Xylakant/gitlabhq into fixes/api
Conflicts:
	doc/api/projects.md
2013-02-27 16:49:45 +01:00
Christian Simon fc0c692870 Add docs/tests for groups api 2013-02-01 14:59:22 +01:00
Felix Gilcher 2ddaf00387 Added documentation for passing the token as header
The documentation was unclear about how to pass the api private token as
header. Updated the doc to include the nessesary information bits and
added an example using the curl command line client.
2013-01-28 14:49:27 +01:00
Felix Gilcher 3c47e6248a remove incorrect information about the api version
The API version is currently not equal to the gitlab major version number. Gitlab 4.1 
still uses API version 3. Point to the lib/api.rb file instead which contains the
autoritative information.
2013-01-28 10:59:39 +01:00
Riyad Preukschas eaa99478a7 Up API version to v3 2012-12-21 18:55:39 +01:00
Nihad Abbasov b17e94c37b update contents of API README 2012-12-01 02:07:57 -08:00
Valeriy Sizov dc53a4f732 API: fix documentation 2012-10-02 18:52:19 +03:00
Nihad Abbasov bbdb2c3fef fix links in API README 2012-09-21 05:06:36 -07:00
Dmitriy Zaporozhets 9aafe77e70 I want be able to get token via api. Used for mobile applications 2012-09-20 17:45:07 +03:00
Alex Denisov 87d40fd276 Docs added 2012-09-16 18:21:59 +03:00
Alex Denisov 09a86bd4d6 Capitlization of /gitlab/i normalized. #1367 2012-09-06 11:21:35 +03:00
Rob Taylor 4cb03183ac Text changes to API documentation 2012-09-04 09:48:33 +01:00
Nihad Abbasov 76e4d94d43 add pagination to API 2012-09-03 04:46:29 -07:00
Robert Speicher 8a49cdc3b4 Add milestone API docs to doc/README and views/help/api
Also removes `closed` attribute option from create action.
2012-08-29 08:45:00 -04:00
randx fee26c58e2 Move snippets api doc to separate file 2012-08-25 19:21:11 +03:00
Nihad Abbasov 024e034890 update API docs 2012-07-24 05:25:01 -07:00
Nihad Abbasov f086676b7c add docs for existing API 2012-07-05 06:57:45 -07:00