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

Prepare release r0.6 #151

Merged
merged 9 commits into from
May 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 41 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,56 @@
# Changelog DeviceStatus
## Table of Contents
- [r0.6](#r06)
- [v0.5.1](#v051)
- [v0.5.0](#v050)
- [v0.5.0-rc](#v050-rc)
- [v0.4.1](#v041)
- [v0.2.0](#v020)

# r0.6
## Please note:
- This release contains an alpha version of the API, it should be considered as a draft.
- There are bug fixes to be expected and incompatible changes in upcoming versions.

## Device Status - v0.6.0-alpha.1
- API definition **with inline documentation**:
- OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/release-0.6/code/API_definitions/device-status.yaml)
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.6/code/API_definitions/device-status.yaml&nocors)
- [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.6/code/API_definitions/device-status.yaml)
### Main Changes
* Endpoints renamed
* New response parameter lastStatusTime

### Added
* Addition of "lastStatusTime" Field by @sachinvodafone in https://github.com/camaraproject/DeviceStatus/pull/146
* include x-correlator by @fernandopradocabrillo in https://github.com/camaraproject/DeviceStatus/pull/112

### Changed
* Change endpoint names to comply with guideline by @gmuratk in https://github.com/camaraproject/DeviceStatus/pull/131
* renaming "EventType"-components to be more clear & update component descriptions by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/141
* Make '+' mandatory for phoneNumber by @bigludo7 in https://github.com/camaraproject/DeviceStatus/pull/144

### Fixed
* NA

### Removed
* NA

## New Contributors
* NA

**Full Changelog**: https://github.com/camaraproject/DeviceStatus/compare/v0.5.1...r0.6


# v0.5.1
**This is a bugfix release for the third alpha version of the CAMARA DeviceStatus API**
**This is a bugfix release for the third initial version of the CAMARA DeviceStatus API**
- API definition **with inline documentation**:
- OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/release-0.5.1/code/API_definitions/device-status.yaml)
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.5.1/code/API_definitions/device-status.yaml&nocors)
- [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.5.1/code/API_definitions/device-status.yaml)

## Please note:
- This is an alpha version, it should be considered as a draft.
- This is an initial version, it should be considered as a draft.
- There are bug fixes to be expected and incompatible changes in upcoming versions.
- The release is suitable for implementors, but it is not recommended to use the API with customers in productive environments.

Expand Down Expand Up @@ -45,15 +81,15 @@


# v0.5.0
**This is the third alpha version of the CAMARA DeviceStatus API**
**This is the third initial version of the CAMARA DeviceStatus API**
- API definition **with inline documentation**:
- OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/release-0.5.0/code/API_definitions/device-status.yaml)
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.5.0/code/API_definitions/device-status.yaml&nocors)
- [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.5.0/code/API_definitions/device-status.yaml)

## Please note:
- **This release contains significant changes compared to v0.4.1, and it is not backward compatible**
- This is an alpha version, it should be considered as a draft.
- This is an initial version, it should be considered as a draft.
- There are bug fixes to be expected and incompatible changes in upcoming versions.
- The release is suitable for implementors, but it is not recommended to use the API with customers in productive environments.

Expand Down Expand Up @@ -91,7 +127,7 @@


# v0.5.0-rc
**This is the release candidate of v0.5.0 - containing the upcoming 3rd alpha version of the DeviceStatus API**
**This is the release candidate of v0.5.0 - containing the upcoming 3rd initial version of the DeviceStatus API**
- API definition **with inline documentation**:
- OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/release-0.5.0-rc/code/API_definitions/device-status.yaml)
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.5.0-rc/code/API_definitions/device-status.yaml&nocors)
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ Repository to describe, develop, document and test the DeviceStatus API family
* Note: Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available public release**.

<!-- following part left in for now but could be omitted going forward -->
* The latest available and released version 0.5.1 of the API is available within the [release-0.5.1 branch](https://github.com/camaraproject/DeviceStatus/tree/release-0.5.1)
* The latest available release version 0.6 (with API version 0.6.0-alpha.1) is available [here](https://github.com/camaraproject/DeviceStatus/tree/r0.6)
- API definition with inline documentation:
- OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/release-0.5.1/code/API_definitions/device-status.yaml)
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.5.1/code/API_definitions/device-status.yaml&nocors)
- [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.5.1/code/API_definitions/device-status.yaml)
- OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/r0.6/code/API_definitions/device-status.yaml)
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/r0.6/code/API_definitions/device-status.yaml&nocors)
- [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/r0.6/code/API_definitions/device-status.yaml)

## Contributing
* Meetings
Expand Down
4 changes: 2 additions & 2 deletions code/API_definitions/device-status.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -101,13 +101,13 @@ info:
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: wip
version: 0.6.0-alpha.1
akoshunyadi marked this conversation as resolved.
Show resolved Hide resolved
externalDocs:
description: Product documentation at CAMARA
url: https://github.com/camaraproject/

servers:
- url: "{apiRoot}/device-status/v0"
- url: "{apiRoot}/device-status/v0.6alpha1"
variables:
apiRoot:
default: http://localhost:9091
Expand Down