diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..a005ebc --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,47 @@ + +# Changelog CAMARA IoTNetworkOptimization + +## Table of Contents + +- **[r1.1](#r11)** + +**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 it has been released. For example, changes may be reverted before a release is published. For the best results, use the latest published release.** + +The below sections record the changes for each API version in each release as follows: + +* for an alpha release, the delta with respect to the previous release +* for the first release-candidate, all changes since the last public release +* for subsequent release-candidate(s), only the delta to the previous release-candidate +* for a public release, the consolidated changes since the previous public release + +# r1.1 + +## Release Notes + +This release contains the definition and documentation of: +* iot-network-optimization v0.1.0-alpha.1 + + +## iot-network-optimization v0.1.0-alpha.1 +This is an alpha release of the CAMARA IoTNetworkOptimization API supporting the activation of power-saving network features for a fleet of IoT devices. + +- API definition **with inline documentation**: + - OpenAPI [YAML spec file](https://github.com/camaraproject/IoTNetworkOptimization/blob/r1.1/code/API_definitions/iot-network-optimization.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/IoTNetworkOptimization/r1.1/code/API_definitions/iot-network-optimization.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/IoTNetworkOptimization/r1.1/code/API_definitions/iot-network-optimization.yaml) + +## Please note: + +- This pre-release contains a release-candidate API version, there are bug fixes to be expected and incompatible changes in upcoming versions +- The release is suitable for implementers, but it is not recommended to use the API with customers in productive environments +- The release scope is defined here: https://github.com/camaraproject/IoTNetworkOptimization/issues/50 + +## What's New + +* Support for the following use cases: https://github.com/camaraproject/IoTNetworkOptimization/discussions/11 + +## New Contributors +* @FabrizioMoggio +* @varanto + +**Full Changelog**: https://github.com/camaraproject/IoTNetworkOptimization/commits/r1.1 \ No newline at end of file diff --git a/README.md b/README.md index ef1af2a..746c748 100644 --- a/README.md +++ b/README.md @@ -24,12 +24,14 @@ Sandbox API Repository to describe, develop, document, and test the IoTNetworkOp ## Release Information -The repository has no (pre)releases yet, work in progress is within the main branch. - - - - - +* 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 release**. + +* `NEW`: The latest pre-release is [r1.1](https://github.com/camaraproject/IoTNetworkOptimization/releases/tag/r1.1) with **iot-network-optimization v0.1.0-alpha.1** is available. + * version v0.1.0-alpha.1 of the **API iot-network-optimization** - available [here](https://github.com/camaraproject/IoTNetworkOptimization/tree/r1.1) + * API definitions **with inline documentation**: + * OpenAPI [YAML](https://github.com/camaraproject/IoTNetworkOptimizationn/blob/r1.1/code/API_definitions/iot-network-optimization.yaml) + * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/IoTNetworkOptimization/refs/tags/r1.1/code/API_definitions/iot-network-optimization.yaml&nocors) + * [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/IoTNetworkOptimization/refs/tags/r1.1/code/API_definitions/iot-network-optimization.yaml) ## Contributing diff --git a/code/API_definitions/iot-network-optimization.yaml b/code/API_definitions/iot-network-optimization.yaml index 6bbce6d..a5bfe21 100644 --- a/code/API_definitions/iot-network-optimization.yaml +++ b/code/API_definitions/iot-network-optimization.yaml @@ -116,7 +116,7 @@ info: ## Release Notes First draft for the IoT Network Optimization API. - version: wip + version: 0.1.0-alpha.1 license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html @@ -128,7 +128,7 @@ externalDocs: # Servers # ############################################################################ servers: - - url: "{apiRoot}/iot-network-opt/vwip" + - url: "{apiRoot}/iot-network-optimization/v0.1alpha1" variables: apiRoot: default: http://localhost:9091 @@ -160,8 +160,8 @@ paths: schema: $ref: '#/components/schemas/PowerSavingRequest' responses: - "200": - description: Power-saving feature request sent successfully + "202": + description: Power-saving feature request accepted headers: x-correlator: $ref: '#/components/headers/x-correlator' @@ -177,6 +177,8 @@ paths: $ref: "#/components/responses/Generic403" "404": $ref: "#/components/responses/Generic404" + "409": + $ref: "#/components/responses/Generic409" "501": $ref: "#/components/responses/Generic501" callbacks: @@ -345,7 +347,7 @@ components: Note: the maximum number of event types per subscription will be decided at API project level type: array minItems: 1 - maxItems: 1 + maxItems: 2 items: $ref: "#/components/schemas/SubscriptionEventType" config: @@ -921,6 +923,31 @@ components: status: 404 code: UNKNOWN_APPLICATION_IDENTIFIER message: the target application is unknown. + Generic409: + description: Conflict + headers: + x-correlator: + $ref: "#/components/headers/x-correlator" + content: + application/json: + schema: + allOf: + - $ref: "#/components/schemas/ErrorInfo" + - type: object + properties: + status: + enum: + - 409 + code: + enum: + - CONFLICT + examples: + GENERIC_409_CONFLICT: + description: Device already in the requested state or conflicting operation in progress + value: + status: 409 + code: CONFLICT + message: The device is already in the requested power-saving state or a conflicting operation is in progress. Generic410: description: Gone headers: diff --git a/documentation/API_documentation/iot-network-optimization-API-Readiness-Checklist.md b/documentation/API_documentation/iot-network-optimization-API-Readiness-Checklist.md index a8bd45e..d050d9d 100644 --- a/documentation/API_documentation/iot-network-optimization-API-Readiness-Checklist.md +++ b/documentation/API_documentation/iot-network-optimization-API-Readiness-Checklist.md @@ -5,18 +5,18 @@ Checklist for kyc-match vwip | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| | 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/iot-network-optimization.yaml) | -| 2 | Design guidelines from Commonalities applied | O | M | M | M | N | | -| 3 | Guidelines from ICM applied | O | M | M | M | N | | -| 4 | API versioning convention applied | M | M | M | M | Y | | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | N | not fully checked | +| 3 | Guidelines from ICM applied | O | M | M | M | N | not fully checked | +| 4 | API versioning convention applied | M | M | M | M | Y | 0.1.0-alpha.1 | | 5 | API documentation | M | M | M | M | Y | Embedded documentation into API spec - [link](/code/API_definitions/iot-network-optimization.yaml) | | 6 | User stories | O | O | O | M | Y | [link](/documentation/API_documentation/IoT_Network_Optimization_UserStory_UseCase_1) | | 7 | Basic API test cases & documentation | O | M | M | M | Y | [link](/code/Test_definitions/iot-network-optimization-power-saving.feature) | -| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | | +| 8 | Enhanced API test cases & documentation | O | O | O | M | N | | | 9 | Test result statement | O | O | O | M | N | | -| 10 | API release numbering convention applied | M | M | M | M | Y | | -| 11 | Change log updated | M | M | M | M | N | | +| 10 | API release numbering convention applied | M | M | M | M | Y | r1.1 | +| 11 | Change log updated | M | M | M | M | Y | | | 12 | Previous public release was certified | O | O | O | M | N | | -| 13 | API description (for marketing) | O | O | M | M | | [wiki link](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/129204225/IoTNetworkOptimization) | +| 13 | API description (for marketing) | O | O | M | M | | [wiki link](https://lf-camaraproject.atlassian.net/wiki/x/AQCGDg) | To fill the checklist: - in the line above the table, replace the api-name, api-version and the rx.y by their actual values for the current API version and release.