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

Publish OpenAPI schema for our Open311 extensions #5016

Closed
davea opened this issue Jun 18, 2024 · 2 comments · Fixed by mysociety/fixmystreet.com#63
Closed

Publish OpenAPI schema for our Open311 extensions #5016

davea opened this issue Jun 18, 2024 · 2 comments · Fixed by mysociety/fixmystreet.com#63

Comments

@davea
Copy link
Member

davea commented Jun 18, 2024

We publish a wiki page outlining our extensions to the Open311 spec: https://github.com/mysociety/fixmystreet/wiki/Open311-FMS---Complete-Spec

It might be nice to capture those in an OpenAPI schema - perhaps building on top of https://github.com/open311/schema-validation/blob/master/schema/georeport-v2/swagger.json

@davea
Copy link
Member Author

davea commented Jun 25, 2024

Maybe 3-4 hours for someone to get a handle on the OpenAPI spec and include our additions - it's just a YAML/JSON doc.

If we wanted to be extra helpful I suppose setting up an interactive hosted version of the spec using Swagger/ReDoc might be worthwhile, but that becomes a bigger task. Maybe another hour to investigate options and decide what to do.

@dracos
Copy link
Member

dracos commented Oct 8, 2024

Published at https://pages.mysociety.org/fixmystreet.com/open311-openapi/ can be edited in fixmystreet.com repo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants