Spec.yaml ( ?doc page) doesn't work well.
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	Mvolz
	Jan 15 2018, 2:23 PM

Description

The express landing page at http://localhost:1970/api was removed and replaced with ?doc, but the ?doc page is not working correctly as the "try it out" button 404s.

Details

	Subject	Repo	Branch	Lines +/-
	Improve swagger docs	mediawiki/services/citoid	master	+53 -3

Customize query in gerrit

Event Timeline

Mvolz created this task.Jan 15 2018, 2:23 PM

Restricted Application added a project: VisualEditor. · View Herald TranscriptJan 15 2018, 2:23 PM

Restricted Application added a subscriber: Aklapper. · View Herald Transcript

Mvolz triaged this task as Medium priority.Jan 15 2018, 2:23 PM

Citoid is not exposed to the world directly, so that URL is not reachable at all. If one wants to get the API docs, they should point their browser to http://localhost:1970/?doc. But again, this is all local, in production none of this can be seen, so I'm not sure this ticket is relevant.

• Deskana moved this task from To Triage to External and Administrivia on the VisualEditor board.Jan 16 2018, 7:31 PM

In T184913#3901363, @mobrovac wrote:

Citoid is not exposed to the world directly, so that URL is not reachable at all. If one wants to get the API docs, they should point their browser to http://localhost:1970/?doc. But again, this is all local, in production none of this can be seen, so I'm not sure this ticket is relevant.

Well, at the very least I use it for testing :). It's nice to have a page that people can navigate to if they're trying to get it to run locally.

?doc could be a real replacement, but currently it is a little broken; the sample query there goes to localhost/api, which, of course, is now 400 response!

Mvolz renamed this task from HTML landing page at http://localhost:1970/api is no longer being served to Either restore landing page at http://localhost:1970/api or improve ?doc page.Jan 18 2018, 1:52 PM

Mvolz claimed this task.Mar 19 2018, 10:31 AM

Mvolz renamed this task from Either restore landing page at http://localhost:1970/api or improve ?doc page to Spec.yaml ( ?doc page) doesn't seem to be parsing the x-amples. .Mar 19 2018, 11:28 AM

Mvolz removed Mvolz as the assignee of this task.

Mvolz updated the task description. (Show Details)

Mvolz renamed this task from Spec.yaml ( ?doc page) doesn't seem to be parsing the x-amples. to Spec.yaml ( ?doc page) doesn't work well..Mar 19 2018, 11:38 AM

Mvolz updated the task description. (Show Details)

Mvolz claimed this task.Mar 19 2018, 11:47 AM

Change 420313 had a related patch set uploaded (by Mvolz; owner: Mvolz):
[mediawiki/services/citoid@master] Improve swagger docs

https://gerrit.wikimedia.org/r/420313

gerritbot added a project: Patch-For-Review.Mar 19 2018, 12:18 PM

Change 420313 merged by Mobrovac:
[mediawiki/services/citoid@master] Improve swagger docs

https://gerrit.wikimedia.org/r/420313