Re: [openstreetmap/openstreetmap-website] [💡] Documenting API using Swagger / rswag (#3107)

Andy Allan notifications at
Wed Mar 3 11:51:54 UTC 2021

> I think @gravitystorm would agree that Rails port will continue to be the center of gravity for functional requirements, database table definitions and a reference implementation, regardless of what we're doing in production.

Yep, I would agree with that whole-heartedly. I also have plans to make this codebase (slightly) more performant, which will reduce the need for some deployments to add cgimap. So even if OSMF don't use some of the API calls in production, other installations will continue to do so.

> "part-time maintainer to assist Andy Allan."

Thanks for pointing this out; I haven't been involved in any of the discussions but I suspect this has been more focussed on OSMF budget opportunities rather than actually progressing it yet.

> The later still requires significant effort regardless of the system.

@simonpoole I'm not familiar with swagger or the maproulette documentation. Could you give some idea here as to what else would be involved? Is it inline controller method documentation, or more, or something else? Do you have any links to good/bad examples?

I'm quite happy to have the documentation here in the repo, preferably near the code but I'd rather it was under source control than in a free-for-all.

> Testing the /api/capabilities endpoints in the browser

@mmd-osm Is it just get requests that can be tested? I'm concerned because other systems I'm more familiar with that allow online testing like this either have a 'test mode' API, or it's only your own account that you can mess up by playing around while logged in. On the flip side, if all you can test are get requests, it becomes a bit less interesting! Do you have any details on this?

You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <>

More information about the rails-dev mailing list