Swagger.v1.json template #3572

0rzech · 2018-02-23T16:09:30Z

Turns swagger.v1.json into template and renames ENABLE_SWAGGER_ENDPOINT option added in #3502 to ENABLE_SWAGGER to better reflect its meaning. Resolves #3499.

codecov-io · 2018-02-23T16:30:51Z

Codecov Report

Merging #3572 into master will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master   #3572   +/-   ##
======================================
  Coverage    20.2%   20.2%           
======================================
  Files         156     156           
  Lines       31140   31140           
======================================
  Hits         6292    6292           
  Misses      23890   23890           
  Partials      958     958

Impacted Files	Coverage Δ
routers/api/v1/misc/swagger.go	`0% <ø> (ø)`	⬆️

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 412583a...15bce8f. Read the comment docs.

sapk

LGTM for the most. Just need two little modifications.

sapk · 2018-02-24T14:13:31Z

routers/routes/routes.go

@@ -710,6 +710,10 @@ func RegisterRoutes(m *macaron.Macaron) {
 		m.Post("/purge", user.NotificationPurgePost)
 	}, reqSignIn)

+	if setting.API.EnableSwaggerEndpoint {


You should add to https://github.com/go-gitea/gitea/blob/master/custom/conf/app.ini.sample#L556 that it also disable the json.

Fixed by leaving more generic option name and description. ;) This option is scheduled to be released in 1.5.0, so it's safe to change its name now.

sapk · 2018-02-24T14:16:41Z

Makefile

@@ -89,7 +89,8 @@ generate-swagger:
 	@hash swagger > /dev/null 2>&1; if [ $$? -ne 0 ]; then \
 		$(GO) get -u github.com/go-swagger/go-swagger/cmd/swagger; \
 	fi
-	swagger generate spec -o ./public/swagger.v1.json
+	swagger generate spec -o ./templates/swagger/v1_json.tmpl
+	$(SED_INPLACE) 's;"basePath":\s*"/api/v1";"basePath": "{{AppSubUrl}}/api/v1";g' ./templates/swagger/v1_json.tmpl


Note for an other PR: We should update the version of the api declare in the json or use the template to do so.

sapk · 2018-02-24T14:18:02Z

docs/.gitignore

@@ -1,2 +1,3 @@
 public/
+templates/swagger/v1_json.tmpl


The file should not be ignored as CI check that the file is valid with the generation (re-generate and check if git detect changes)

It has been ignored all the time. This file was moved from public directory, which, as you can see, is ignored too. Also, this is docs/.gitignore and not top level .gitignore.

Oh sorry, I didn't see that it wasn't top-level ...

No problem.

lunny · 2018-02-25T13:42:10Z

But It seems it not work for me locally.

0rzech · 2018-02-25T20:30:04Z

@lunny What exactly does not work? I didn't spot any problems.

If you put ROOT_URL = %(PROTOCOL)s://%(DOMAIN)s:%(HTTP_PORT)s/ in app.ini, then downloaded swagger.v1.json should contain "basePath": "/api/v1", as it does now.

If you put ROOT_URL = %(PROTOCOL)s://%(DOMAIN)s:%(HTTP_PORT)s/some_path in app.ini, then downloaded swagger.v1.json should contain "basePath": "/some_path/api/v1".

0rzech · 2018-03-25T14:39:25Z

@lunny Could you reply to my previous comment?

0rzech · 2018-07-18T00:23:42Z

@lunny Do you confirm that there's a bug after checking my comment?
@sapk Is there anything more you'd like to discuss before approving changes? You're still shown as requesting changes to this PR.

techknowlogick · 2018-07-19T17:45:44Z

@0rzech how would make swagger-validate be able to validate this template?

0rzech · 2018-07-20T00:04:14Z

@techknowlogick In general, it would return an error that basePath does not start with ^/. That's why {{AppSubUrl}} is removed from file for validation purposes and is immediately placed back after validation is finished. It's all in swagger-validate recipe.

sapk · 2018-07-27T09:19:17Z

custom/conf/app.ini.sample

-; Enables /api/swagger, /api/v1/swagger etc. endpoints. True or false; default is true.
-ENABLE_SWAGGER_ENDPOINT = true
+; Enables Swagger. True or false; default is true.
+ENABLE_SWAGGER = true


I am not against this change but it will need to be indicated as breaking. So we need to add the label kind/breaking on PR.

we need to add the label kind/breaking on PR

Yup.

sapk · 2018-07-27T09:22:12Z

templates/swagger/v1_json.tmpl

@@ -21,7 +21,7 @@
    },
    "version": "1.1.1"


Could you also fill the version with the corresponding var ?

Yes, but I think it should be done in another PR, if at all.

sapk · 2018-07-27T09:26:51Z

@0rzech if we use template the validation should occur in integration tests but as this the PR seems good.

sapk

Could be improved but this PR lay down good bases for swagger template. Others changes could be done in a separate PR.

lafriks · 2018-07-27T22:56:37Z

@0rzech please rebase/merge changes to be up to date with master so this could be merged. Or check that gitea maintainers do it for you

0rzech · 2018-07-28T00:07:36Z

@lafriks Rebased.

0rzech · 2018-07-28T00:23:09Z

Others changes could be done in a separate PR.

@sapk This is what I think as well.

Prepare for wild/v1.6 branch * BREAKING * Respect email privacy option in user search via API (go-gitea#4512) * Simply remove tidb and deps (go-gitea#3993) * Swagger.v1.json template (go-gitea#3572) * FEATURE * Pull request review/approval and comment on code (go-gitea#3748) * Added dependencies for issues (go-gitea#2196) (go-gitea#2531) * Add the ability to have built in themes in Gitea and provide dark theme arc-green (go-gitea#4198) * Add sudo functionality to the API (go-gitea#4809) * Add oauth providers via cli (go-gitea#4591) * Disable merging a WIP Pull request (go-gitea#4529) * Force user to change password (go-gitea#4489) * Add letsencrypt to Gitea (go-gitea#4189) * Add push webhook support for mirrored repositories (go-gitea#4127) * Add csv file render support defaultly (go-gitea#4105) * Add Recaptcha functionality to Gitea (go-gitea#4044) * BUGFIXES * Fix release creation via API (go-gitea#5076) * Remove links from topics in edit mode (go-gitea#5026) * Fix missing AppSubUrl in few more templates (fixup) (go-gitea#5021) * Fix missing AppSubUrl in some templates (go-gitea#5020) * Hide outdated comments in file view (go-gitea#5017) * Upgrade gopkg.in/testfixtures.v2 (go-gitea#4999) * Disable debug routes unless PPROF is enabled in configuration (go-gitea#4995) * Fix user menu item styling (go-gitea#4985) * Fix layout of the topics editing form (go-gitea#4971) * Fix null pointer dereference in ParseCommitWithSignature (go-gitea#4962) * Fix url in discord webhook (go-gitea#4953) * Detect charset and convert non UTF-8 files for display (go-gitea#4950) * Make sure to catch the right error so it is displayed on the UI (go-gitea#4945) * Fix(topics): don't redirect to explore page. (go-gitea#4938) * Fix bug forget to remove Stopwatch when remove repository (go-gitea#4928) * Fix bug when repo remained bare if multiple branches pushed in single push (go-gitea#4923) * Fix: Let's Encrypt configuration settings (go-gitea#4911) * Fix: Crippled diff (go-gitea#4726) (go-gitea#4900) * Fix trimming of markup section names (go-gitea#4863) * Issues api allow pulls and fix go-gitea#4832 (go-gitea#4852) * Do not autocreate directory for new users/orgs (go-gitea#4828) (go-gitea#4849) * Fix redirect with non-ascii branch names (go-gitea#4764) (go-gitea#4810) * Fix missing release title in webhook (go-gitea#4783) (go-gitea#4796) * User shouldn't be able to approve or reject his/her own PR (go-gitea#4729) * Make sure to reset commit count in the cache on mirror syncing (go-gitea#4720) * Fixed bug where team with admin privelege type doesn't get any unit (go-gitea#4719) * Fix incorrect caption of webhook setting (go-gitea#4701) (go-gitea#4717) * Allow WIP marker to contains < or > (go-gitea#4709) * Hide org/create menu item in Dashboard if user has no rights (go-gitea#4678) (go-gitea#4680) * Site admin could create repos even MAX_CREATION_LIMIT=0 (go-gitea#4645) * Fix custom templates being ignored (go-gitea#4638) * Fix starring icon after semantic ui update (go-gitea#4628) * Fix Split-View line adjustment (go-gitea#4622) * Fix integer constant overflows in tests (go-gitea#4616) * Push whitelist now doesn't apply to branch deletion (go-gitea#4601) (go-gitea#4607) * Fix bugs when too many IN variables (go-gitea#4594) * Fix failure on creating pull request with assignees (go-gitea#4419) (go-gitea#4583) * Fix panic issue on update avatar email (go-gitea#4580) (go-gitea#4581) * Fix status code label for a successful webhook (go-gitea#4540) * An inactive user shouldn't be able to be added as a collaborator (go-gitea#4535) * Don't fail silently if trying to add a collaborator twice (go-gitea#4533) * Fix incorrect MergeWhitelistTeamIDs check in CanUserMerge function (go-gitea#4519) (go-gitea#4525) * Fix out-of-transaction query in removeOrgUser (go-gitea#4521) (go-gitea#4522) * Fix migration from older releases (go-gitea#4495) * Accept 'Data:' in commit graph (go-gitea#4487) * Update xorm to latest version and fix correct `user` table referencing in sql (go-gitea#4473) * Relative URLs for LibreJS page (go-gitea#4460) * Redirect to correct page after using scratch token (go-gitea#4458) * Fix column droping for MSSQL that need new transaction for that (go-gitea#4440) * Replace src with raw to fix image paths (go-gitea#4377) * Add default merge options when creating new repository (go-gitea#4369) * Fix docker build (go-gitea#4358) * Fixes repo membership check in API (go-gitea#4341) * Dep upgrade mysql lib (go-gitea#4161) * Fix some issues with special chars in branch names (go-gitea#3767) * Responsive design fixes (go-gitea#4508) * ENHANCEMENT * Fix milestones sorted wrongly (go-gitea#4987) * Allow api to create tags for releases if they don't exist (go-gitea#4890) * Fix go-gitea#4877 to follow the OpenID Connect Audiences spec (go-gitea#4878) * Enforce token on api routes [fixed critical security issue go-gitea#4357] (go-gitea#4840) * Update legacy branch and tag URLs in dashboard to new format (go-gitea#4812) * Slack webhook channel name cannot be empty or just contain an hashtag (go-gitea#4786) * Add whitespace handling to PR-comparsion (go-gitea#4683) * Make reverse proxy auth optional (go-gitea#4643) * MySQL TLS (go-gitea#4642) * Make sure to set PR split view when creating/previewing a pull request (go-gitea#4617) * Log user in after a successful sign up (go-gitea#4615) * Fix typo IsPullReuqestBroken -> IsPullRequestBroken (go-gitea#4578) * Allow admin toggle forcing a password change for newly created users (go-gitea#4563) * Update jQuery to v1.12.4 (go-gitea#4551) * Env var GITEA_PUSHER_EMAIL (go-gitea#4516) * Feat(repo): support search repository by topic name (go-gitea#4505) * Small improvements to dependency UI (go-gitea#4503) * Make max commits in graph configurable (go-gitea#4498) * Add valid for lfs oid (go-gitea#4461) * Add shortcut to save wiki page (go-gitea#4452) * Allow administrator to create repository for any organization (go-gitea#4368) * Fix repository last updated time update when delete a user who watched the repo (go-gitea#4363) * Switch plaintext scratch tokens to use hash instead (go-gitea#4331) * Increase default TOTP secret size to 320 bits (go-gitea#4287) * Keep preseeded database password (go-gitea#4284) * Implemented hover text showing user FullName (go-gitea#4261) * Add ability to delete a token (go-gitea#4235) * Fix typos in i18n variable names. (go-gitea#4080) * Api: repos/search: add parameters to control the sort order (go-gitea#3964) * Add missing path in the Docker app.ini template (go-gitea#2181) * Add file name and branch to page title (go-gitea#4902) * Offline use of google fonts (go-gitea#4872) * Add missing History link to directory listings v2 (go-gitea#4829) * Locale for Edit and Remove due date issue (go-gitea#4802) * Disable 'May Import Local Repository' when is disabled by setting (Is… (go-gitea#4780) * API /admin/users/{username} missing parameter (go-gitea#4775) * Display error when adding a user to a team twice (go-gitea#4746) * Remove UsePrivilegeSeparation from the Docker sshd_config, see go-gitea#2876 (go-gitea#4722) * Focus title input when clicking helper link (go-gitea#4696) * Add vendor to user reserved words and format words list according alphabet (go-gitea#4685) * Add gitea/issues link to 500 page (go-gitea#4654) * Hide home button when landing page is not set to home (go-gitea#4651) * Remove link to GitHub issues in 404 template (go-gitea#4639) * Cmd/serve: pprof cpu and memory profile dumps to disk (go-gitea#4560) * Add flash message after an account has been successfully activated (go-gitea#4510) * Prevent html entity escaping on delete branch (go-gitea#4471) * Locale for button Edit on protected branch (go-gitea#4442) * Update notification icon (go-gitea#4343) * Added front-end topics validation (go-gitea#4316) * Don't display buttons if there are no system notifications (go-gitea#4280) * Issue due date api (go-gitea#3890) * SECURITY * Improve URL validation for external wiki and external issues (go-gitea#4710) * Make cookies HttpOnly and obey COOKIE_SECURE flag (go-gitea#4706) * Don't disclose emails of all users when sending out emails (go-gitea#4664) * Check that repositories can only be migrated to own user or organizations (go-gitea#4366) * TRANSLATION * Fix punctuation in English translation (go-gitea#4958) * Fix translation (go-gitea#4355)

Updates documentation to account for the renamed ENABLE_SWAGGER_ENDPOINT from #3572 (commit a74426d) Signed-off-by: Peter Colberg <peter@colberg.org>

Updates documentation to account for the renamed ENABLE_SWAGGER_ENDPOINT from go-gitea#3572 (commit a74426d) Signed-off-by: Peter Colberg <peter@colberg.org>

tboerger added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Feb 23, 2018

lafriks added type/bug type/docs This PR mainly updates/creates documentation modifies/api This PR adds API routes or modifies them labels Feb 23, 2018

lafriks added this to the 1.5.0 milestone Feb 23, 2018

sapk suggested changes Feb 24, 2018

View reviewed changes

techknowlogick modified the milestones: 1.5.0, 1.6.0 May 25, 2018

ghost approved these changes Jul 26, 2018

View reviewed changes

bkcsoft added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Jul 26, 2018

sapk reviewed Jul 27, 2018

View reviewed changes

sapk approved these changes Jul 27, 2018

View reviewed changes

bkcsoft 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 Jul 27, 2018

0rzech added 2 commits July 28, 2018 02:05

Turn swagger.v1.json into template

c935add

Rename ENABLE_SWAGGER_ENDPOINT option to ENABLE_SWAGGER

15bce8f

lafriks added the pr/breaking Merging this PR means builds will break. Needs a description what exactly breaks, and how to fix it! label Jul 28, 2018

lafriks merged commit a74426d into go-gitea:master Jul 28, 2018

0rzech mentioned this pull request Aug 7, 2018

URL Composition Problems with Alternative Port Configurations #2403

Closed

7 tasks

techknowlogick mentioned this pull request Aug 17, 2018

Create Progressive Web App #4730

Merged

3 tasks

zeripath pushed a commit that referenced this pull request Jan 23, 2019

Adapt documentation to renamed ENABLE_SWAGGER option (#5811)

904188c

Updates documentation to account for the renamed ENABLE_SWAGGER_ENDPOINT from #3572 (commit a74426d) Signed-off-by: Peter Colberg <peter@colberg.org>

go-gitea locked and limited conversation to collaborators Nov 24, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Swagger.v1.json template #3572

Swagger.v1.json template #3572

0rzech commented Feb 23, 2018 •

edited

codecov-io commented Feb 23, 2018 •

edited

sapk left a comment

sapk Feb 24, 2018

0rzech Feb 24, 2018 •

edited

sapk Feb 24, 2018 •

edited

sapk Feb 24, 2018

0rzech Feb 24, 2018 •

edited

sapk Feb 24, 2018

0rzech Feb 24, 2018

lunny commented Feb 25, 2018

0rzech commented Feb 25, 2018 •

edited

0rzech commented Mar 25, 2018 •

edited

0rzech commented Jul 18, 2018 •

edited

techknowlogick commented Jul 19, 2018

0rzech commented Jul 20, 2018 •

edited

sapk Jul 27, 2018

0rzech Jul 28, 2018

sapk Jul 27, 2018

0rzech Jul 28, 2018 •

edited

sapk commented Jul 27, 2018

sapk left a comment •

edited

lafriks commented Jul 27, 2018

0rzech commented Jul 28, 2018

0rzech commented Jul 28, 2018

Swagger.v1.json template #3572

Swagger.v1.json template #3572

Conversation

0rzech commented Feb 23, 2018 • edited

codecov-io commented Feb 23, 2018 • edited

Codecov Report

sapk left a comment

Choose a reason for hiding this comment

sapk Feb 24, 2018

Choose a reason for hiding this comment

0rzech Feb 24, 2018 • edited

Choose a reason for hiding this comment

sapk Feb 24, 2018 • edited

Choose a reason for hiding this comment

sapk Feb 24, 2018

Choose a reason for hiding this comment

0rzech Feb 24, 2018 • edited

Choose a reason for hiding this comment

sapk Feb 24, 2018

Choose a reason for hiding this comment

0rzech Feb 24, 2018

Choose a reason for hiding this comment

lunny commented Feb 25, 2018

0rzech commented Feb 25, 2018 • edited

0rzech commented Mar 25, 2018 • edited

0rzech commented Jul 18, 2018 • edited

techknowlogick commented Jul 19, 2018

0rzech commented Jul 20, 2018 • edited

sapk Jul 27, 2018

Choose a reason for hiding this comment

0rzech Jul 28, 2018

Choose a reason for hiding this comment

sapk Jul 27, 2018

Choose a reason for hiding this comment

0rzech Jul 28, 2018 • edited

Choose a reason for hiding this comment

sapk commented Jul 27, 2018

sapk left a comment • edited

Choose a reason for hiding this comment

lafriks commented Jul 27, 2018

0rzech commented Jul 28, 2018

0rzech commented Jul 28, 2018

0rzech commented Feb 23, 2018 •

edited

codecov-io commented Feb 23, 2018 •

edited

0rzech Feb 24, 2018 •

edited

sapk Feb 24, 2018 •

edited

0rzech Feb 24, 2018 •

edited

0rzech commented Feb 25, 2018 •

edited

0rzech commented Mar 25, 2018 •

edited

0rzech commented Jul 18, 2018 •

edited

0rzech commented Jul 20, 2018 •

edited

0rzech Jul 28, 2018 •

edited

sapk left a comment •

edited