diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..3bf29c0 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,57 @@ +# Changelog CAMARA SessionInsights + +## 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 + +- session-insights v0.1.0-rc.1 + +The API definition(s) are based on + +- Commonalities v0.6.0 +- Identity and Consent Management v0.4.0 + +## session-insights v0.1.0-rc.1 + +**Initial contribution of Session Insights API definition, including initial documentation, linting, test cases, and OpenAPI spec.** + +- API definition **with inline documentation**: + - OpenAPI [YAML spec file](https://github.com/camaraproject/SessionInsights/blob/r1.1/main/code/API_definitions/session-insights.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SessionInsights/r1.1/code/API_definitions/session-insights.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/SessionInsights/r1.1/code/API_definitions/session-insights.yaml) + +- @benhepworth did most of the work on this initial release +- @kevsy helped out and co-authored several PRs and participated in PR reviews +- This "release" is only tagged to document the history of the API, it is not intended to be used by implementors or API customers +- It was originally an implementation by the CableLabs team, and is now maintained by the Camara Project + +### Added + +- Publish initial yaml +- Add Linting +- Add Test cases +- Align with Commonalities 0.6 +- Update User Story + +### Changed + +### Fixed + +### Removed + +*Full Changelog**: [https://github.com/camaraproject/SessionInsights/commits/r1.1](https://github.com/camaraproject/SessionInsights/commits/r1.1) diff --git a/code/API_definitions/session-insights.yaml b/code/API_definitions/session-insights.yaml index bc047ab..91a9d76 100644 --- a/code/API_definitions/session-insights.yaml +++ b/code/API_definitions/session-insights.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Session Insights API - version: wip + version: 0.1.0-rc.1 x-camara-commonalities: 0.6 license: name: Apache 2.0 @@ -65,7 +65,7 @@ externalDocs: url: https://github.com/camaraproject/SessionInsights servers: - - url: "{apiRoot}/session-insights/vwip" + - url: "{apiRoot}/session-insights/v0.1rc1" variables: apiRoot: default: http://localhost:9091 diff --git a/code/Test_definitions/session-insights-createSession.feature b/code/Test_definitions/session-insights-createSession.feature index 0d1b59c..ae93882 100644 --- a/code/Test_definitions/session-insights-createSession.feature +++ b/code/Test_definitions/session-insights-createSession.feature @@ -16,7 +16,7 @@ Feature: CAMARA Session Insights API, v0.1.0-rc.1 - Operation createSession Background: Common createSession setup Given an environment at "apiRoot" - And the resource "/session-insights/vwip/sessions" + And the resource "/session-insights/v0.1rc1/sessions" And the header "Content-Type" is set to "application/json" And the header "Authorization" is set to a valid access token And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator" diff --git a/code/Test_definitions/session-insights-deleteSession.feature b/code/Test_definitions/session-insights-deleteSession.feature index 346576c..bfe4ca6 100644 --- a/code/Test_definitions/session-insights-deleteSession.feature +++ b/code/Test_definitions/session-insights-deleteSession.feature @@ -16,7 +16,7 @@ Feature: CAMARA Session Insights API, v0.1.0-rc.1 - Operation deleteSession Background: Common deleteSession setup Given an environment at "apiRoot" - And the resource "/session-insights/vwip/sessions/{sessionId}" + And the resource "/session-insights/v0.1rc1/sessions/{sessionId}" And the header "Authorization" is set to a valid access token And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator" And the path parameter "sessionId" is set by default to an existing session sessionId diff --git a/code/Test_definitions/session-insights-getSession.feature b/code/Test_definitions/session-insights-getSession.feature index 4ac5033..77b9549 100644 --- a/code/Test_definitions/session-insights-getSession.feature +++ b/code/Test_definitions/session-insights-getSession.feature @@ -16,7 +16,7 @@ Feature: CAMARA Session Insights API, v0.1.0-rc.1 - Operation getSession Background: Common getSession setup Given an environment at "apiRoot" - And the resource "/session-insights/vwip/sessions/{sessionId}" + And the resource "/session-insights/v0.1rc1/sessions/{sessionId}" And the header "Authorization" is set to a valid access token And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator" And the path parameter "sessionId" is set by default to an existing session sessionId diff --git a/code/Test_definitions/session-insights-retrieveSessions.feature b/code/Test_definitions/session-insights-retrieveSessions.feature index 0d5208e..f267aa6 100644 --- a/code/Test_definitions/session-insights-retrieveSessions.feature +++ b/code/Test_definitions/session-insights-retrieveSessions.feature @@ -14,7 +14,7 @@ Feature: CAMARA Session Insights API, v0.1.0-rc.1 - Operation retrieveSessionsBy Background: Common retrieveSessionsByDevice setup Given an environment at "apiRoot" - And the resource "/session-insights/vwip/retrieve-sessions" + And the resource "/session-insights/v0.1rc1/retrieve-sessions" And the header "Content-Type" is set to "application/json" And the header "Authorization" is set to a valid access token And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator" diff --git a/code/Test_definitions/session-insights-sendMetrics.feature b/code/Test_definitions/session-insights-sendMetrics.feature index 1b23c9c..dde9555 100644 --- a/code/Test_definitions/session-insights-sendMetrics.feature +++ b/code/Test_definitions/session-insights-sendMetrics.feature @@ -17,7 +17,7 @@ Feature: CAMARA Session Insights API, v0.1.0-rc.1 - Operation sendSessionMetrics Background: Common sendSessionMetrics setup Given an environment at "apiRoot" - And the resource "/session-insights/vwip/sessions/{sessionId}/metrics" + And the resource "/session-insights/v0.1rc1/sessions/{sessionId}/metrics" And the header "Content-Type" is set to "application/json" And the header "Authorization" is set to a valid access token And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator" diff --git a/documentation/API_documentation/session-insights-API-Readiness-Checklist.md b/documentation/API_documentation/session-insights-API-Readiness-Checklist.md index ee369a4..7177350 100644 --- a/documentation/API_documentation/session-insights-API-Readiness-Checklist.md +++ b/documentation/API_documentation/session-insights-API-Readiness-Checklist.md @@ -1,24 +1,25 @@ # API Readiness Checklist -Checklist for api-name api-version in rx.y. +Checklist for api-name api-version v0.1.0-rc.1 in r1.1. | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| | 1 | API definition | M | M | M | M | Y | [/code/API_definitions/session-insights.yaml](/code/API_definitions/session-insights.yaml) | -| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | Comm. release nr | -| 3 | Guidelines from ICM applied | O | M | M | M | tbd | ICM release nr | -| 4 | API versioning convention applied | M | M | M | M | tbd | | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r1.1](https://github.com/camaraproject/SessionInsights/releases/tag/r1.1) | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r1.1](https://github.com/camaraproject/SessionInsights/releases/tag/r1.1) | +| 4 | API versioning convention applied | M | M | M | M | Y | | | 5 | API documentation | M | M | M | M | Y | in yaml | | 6 | User stories | O | O | O | M | Y | [/documentation/API_documentation/SessionInsights_User_Story.md](/documentation/API_documentation/SessionInsights_User_Story.md) | -| 7 | Basic API test cases & documentation | O | M | M | M | N | | -| 8 | Enhanced API test cases & documentation | O | O | O | M | N | | -| 9 | Test result statement | O | O | O | M | N | issue link | -| 10 | API release numbering convention applied | M | M | M | M | tbd | | -| 11 | Change log updated | M | M | M | M | tbd | [relative link](/CHANGELOG.md) | -| 12 | Previous public release was certified | O | O | O | M | N | comment | -| 13 | API description (for marketing) | O | O | M | M | Y | [https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/94011619/SessionInsights](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/94011619/SessionInsights) | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | [/code/Test_definitions](/code/Test_definitions) | +| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | | +| 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 | Y | [/CHANGELOG.md](/CHANGELOG.md) | +| 12 | Previous public release was certified | O | O | O | M | N | | +| 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/94011619/SessionInsights) | 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. - in the Status column, put "Y" (yes) if the release asset is available or fulfilled in the current release, a "N" (no) or a "tbd". Example use of "tbd" is in case an alpha or release-candidate API version does not yet provide all mandatory assets for the release. - in the Reference information column, provide the relative links (from the API repository home folder) to the release asset once available, the applicable release numbers (not versions) of Commonalities and ICM, and any other relevant links or information.