Migration to OpenAPI

### Migration to Open API 3 In order to provide better documentation in a more standardized form we have decided to move our documentation to comply with the OpenAPI Standard. You can find more information about it on the official [website](https://swagger.io/). You can find the API docs including guides for common use cases at [https://docs-core.homeq.se/](https://docs-core.homeq.se/). ### Deprecation Procedure Going forward instead of just sending an email with the endpoints that are going to be discontinued we will send out a link to an article that will note the endpoints that will be deprecated and a strategy to migrate to a newer version of the endpoint or an alternative approach to adapt an existing integration. ### Deprecation - Listings - 1st October 2024 As communicated before we are migrating all old endpoints in regards to ad listings to a newer version. This means the following endpoints will be replaced. You can checkout the [version 5 for listings](https://docs-core.homeq.se/#tag/Listings) and the [inventory endpoints](https://docs-core.homeq.se/#tag/Inventory). ```python - /api/v1/adlisting/fetch/ - /api/v3/ad - /api/v4/listings ``` ### Deprecation - Office - 1st November 2024 We also are upgrading some aspects of the Offices API. It is mostly a simple upgrade with some minor adjustments. You can check out the new version [here.](https://docs-core.homeq.se/#tag/Offices) ```python - /api/v2/office ``` ### Deprecation - Authentication - 1st November 2024 Over the years our authentication endpoint also has grown and we are replacing the Version 1 with a better more structured response. You should be able to simply switch to v2 and adjust a little bit how you retrieve the required fields from the response. You can check out the new version [here.](https://docs-core.homeq.se/#tag/Authentication/paths/~1api~1v2~1tokens~1/post) ```python - /api/v1/token/ ```