redmaplemedia / bc-property-api-specification Goto Github PK

We're really glad you're reading this, because we need you to help this project come to fruition.

We invite you to collaborate here in GitHub on the open development of an API specification.

Here at BC Assessment (BCA) we are exploring the potential of developing a new Application Programming Interface (API) that would provide access to BCA’s property data. Doing this work in the open on GitHub is an opportunity for us to understand if such a service would be valuable.

Please read the Discussion Guide for more information, including how you can participate in this project.

A Swagger definition has recently been posted as a starting point for further conversation.

This development map illustrates our thinking on how we could collaborate on the API spec, and potentially on code for the API too.

We may add some technical standards in the future.

Just started.

You can find our project goals here.

Right now we are focused on iterating a Swagger definition, Read this for more information next steps.

This project is all about collaborating on an API specification. We are interested in talking about technical stuff, so we will concentrate on what we are good at and leave the business decisions up to others.

If you want to talk about non-technical considerations, feel free to post an issue. But we may not be able to respond to issues outside the technical scope of this project as that is not our team's expertise. Those issues will likely go into a parking lot for now.

Read this for more on what's in scope.

Pull requests are welcome. If you would like to contribute, please see our CONTRIBUTING guidelines.

Code, data and content in this repository are licensed under different licenses.

• All code in the /code directory is licensed under the Apache License 2.0. See LICENSE.Apache-2.0 in the appropriate directories.

• Source data in the /data directory is licensed under the Open Government License - BC Assessment version 1.0. See OGL-BCA-v1-0 in the appropriate directories.