Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update swagger documentation #2899

Merged
merged 3 commits into from
Nov 13, 2017
Merged

Update swagger documentation #2899

merged 3 commits into from
Nov 13, 2017

Conversation

ethantkoenig
Copy link
Member

@ethantkoenig ethantkoenig commented Nov 12, 2017

Fixes #2635. This PR fixes the following:

  • Add docs for missing endpoints
  • Add documentation for request parameters
  • Make parameter naming consistent
  • Fix response documentation

This PR has no functional change.

@ethantkoenig ethantkoenig mentioned this pull request Nov 12, 2017
3 tasks
Add docs for missing endpoints
Add documentation for request parameters
Make parameter naming consistent
Fix response documentation
@lafriks
Copy link
Member

lafriks commented Nov 12, 2017

LGTM

@codecov-io
Copy link

codecov-io commented Nov 12, 2017

Codecov Report

Merging #2899 into master will increase coverage by 0.04%.
The diff coverage is 78.94%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2899      +/-   ##
==========================================
+ Coverage      27%   27.05%   +0.04%     
==========================================
  Files          89       89              
  Lines       17644    17650       +6     
==========================================
+ Hits         4765     4775      +10     
+ Misses      12193    12189       -4     
  Partials      686      686
Impacted Files Coverage Δ
routers/api/v1/misc/version.go 0% <0%> (ø) ⬆️
routers/api/v1/misc/markdown.go 81.66% <100%> (+3.66%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4287d10...4db6041. Read the comment docs.

@tboerger tboerger added the lgtm/need 1 This PR needs approval from one additional maintainer to be merged. label Nov 12, 2017
@lafriks lafriks added the type/docs This PR mainly updates/creates documentation label Nov 12, 2017
@lafriks lafriks added this to the 1.3.0 milestone Nov 12, 2017
@@ -1,15 +1,7 @@
// Copyright 2015 The Gogs Authors. All rights reserved.
Copy link
Member

@sapk sapk Nov 13, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why you remove copyrigths ? We could add gitea ones ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, fixed

// license that can be found in the LICENSE file.

// Package v1 Gitea API.
//
// This provide API interface to communicate with this Gitea instance.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why you remove the description ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, fixed

@sapk
Copy link
Member

sapk commented Nov 13, 2017

Two little comments that should be fixed. For the rest LGTM. Thanks for doing it, it takes time and few good catch like https://github.com/go-gitea/gitea/pull/2899/files#diff-2620fdbeeb83ce43692534e6c2c39452R315.

@tboerger tboerger added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Nov 13, 2017
@ethantkoenig
Copy link
Member Author

@sapk Fixed. The "Terms of Service" link doesn't work, so that is still removed, everything else is restored.

@lafriks lafriks merged commit f26f4a7 into go-gitea:master Nov 13, 2017
@ethantkoenig ethantkoenig deleted the swagger branch November 14, 2017 03:29
@go-gitea go-gitea locked and limited conversation to collaborators Nov 23, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. type/docs This PR mainly updates/creates documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Swagger errors
5 participants