Merge pull request #112 from camaraproject/jpengar/changelog-v0.1.0-release

Update README and CHANGELOG for release v0.1.0

Author: jpengar

CHANGELOG.md

@@ -1,24 +1,23 @@
-# Changelog
+# Changelog Identity And Consent Management
 
-## X.Y.Z [ALPHA] - YYYY-MM-DD
+# v0.1.0 - Initial version
 
-### Added
+**Initial version of guidelines and documentation that represents the short-term solution agreed in this working group for accessing CAMARA APIs, to be used as a baseline.**
 
-* New property `new_name`
-* New endpoint `new_name`
-* Examples
+## Please note:
 
-### Changed
+The content of the release includes:
 
-* Property `old_name` renamed to `new_name`
-* Format for property `property` changed to `new_format`
+* Identity And Consent Management approved deliverables in **documentation** folder:
+  
+  - **[CAMARA-API-access-and-user-consent.md](https://github.com/camaraproject/IdentityAndConsentManagement/blob/release-0.1.0/documentation/IdentityAndConsentManagement)** - This document defines guidelines for telco operator API exposure platforms to manage CAMARA API access and user consent (when applicable). **This document is the result of the agreements reached in this working group and sets the stage for future discussions**. The major contents of the document added for this baseline release are:
+    - [Glossary of Terms and Concepts](https://github.com/camaraproject/IdentityAndConsentManagement/blob/release-0.1.0/documentation/CAMARA-API-access-and-user-consent.md#glossary-of-terms-and-concepts)
+    - [Applying purpose concept in the authorization request](https://github.com/camaraproject/IdentityAndConsentManagement/blob/release-0.1.0/documentation/CAMARA-API-access-and-user-consent.md#applying-purpose-concept-in-the-authorization-request)
+    - [Authorization flows / grant types](https://github.com/camaraproject/IdentityAndConsentManagement/blob/release-0.1.0/documentation/CAMARA-API-access-and-user-consent.md#authorization-flows--grant-types)
+      - [Authorization code flow (Frontend flow)](https://github.com/camaraproject/IdentityAndConsentManagement/blob/release-0.1.0/documentation/CAMARA-API-access-and-user-consent.md#authorization-code-flow-frontend-flow)
+      - [CIBA flow (Backend flow)](https://github.com/camaraproject/IdentityAndConsentManagement/blob/release-0.1.0/documentation/CAMARA-API-access-and-user-consent.md#ciba-flow-backend-flow)
+      - [Client Credentials](https://github.com/camaraproject/IdentityAndConsentManagement/blob/release-0.1.0/documentation/CAMARA-API-access-and-user-consent.md#client-credentials)
+    - [CAMARA API Specification - Authorization and authentication common guidelines](https://github.com/camaraproject/IdentityAndConsentManagement/blob/release-0.1.0/documentation/CAMARA-API-access-and-user-consent.md#camara-api-specification---authorization-and-authentication-common-guidelines)
+  - **[CAMARA-AuthN-AuthZ-Concept.md](https://github.com/camaraproject/IdentityAndConsentManagement/blob/release-0.1.0/documentation/CAMARA-AuthN-AuthZ-Concept.md)** - This document provides general information and generic recommendations about the authentication and authorization concept based on CAMARA scenarios. It is inherited from the original documentation of the [Commonalities WG](https://github.com/camaraproject/WorkingGroups/tree/main/Commonalities). It was moved to this repository in July 2023, when the Commonalities discussions started to take place in a separate Github repository: https://github.com/camaraproject/Commonalities.
 
-### Fixed
-
-* Typos fixed
-* Reference corrected
-
-### Removed
-
-* Deprecated field `old_field`
-* Deprecated endpoint
+**Full Changelog**: https://github.com/camaraproject/IdentityAndConsentManagement/commits/v0.1.0

README.md

@@ -5,7 +5,7 @@
 <a href="https://github.com/camaraproject/IdentityAndConsentManagement" title="Repo Size"><img src="https://img.shields.io/github/repo-size/camaraproject/IdentityAndConsentManagement?style=plastic"></a>
 <a href="https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/LICENSE" title="License"><img src="https://img.shields.io/badge/License-Apache%202.0-green.svg?style=plastic"></a>
 
-# IdentityAndConsentManagement
+# Identity And Consent Management
 Repository to describe, develop, document and test the Identity And Consent Management API family
 
 ## Scope
@@ -20,11 +20,10 @@ Repository to describe, develop, document and test the Identity And Consent Mana
 * Schedule: bi-weekly, Wednesday, 4 PM CET/CEST (15:00 UTC, 14:00 UTC during European DST). For next call, see minutes of [previous meetings](documentation/MeetingMinutes) 
 * Meeting link: [Microsoft Teams Meeting](https://teams.microsoft.com/l/meetup-join/19%3ameeting_MGVkMDUwMTYtNTZiNy00MmMzLWE1M2QtN2Q1ZmEwOWVmZDQ2%40thread.v2/0?context=%7b%22Tid%22%3a%229744600e-3e04-492e-baa1-25ec245c6f10%22%2c%22Oid%22%3a%22ec8dd69b-01fe-4d41-a294-c2927b548e27%22%7d)
 
-## Results and Status
-* Current Version: v0.1.0 WIP
-  * API [definition](code/API_definitions)
-  * API [documentation](documentation/API_documentation)
-  * For changes see [CHANGELOG.md](CHANGELOG.md)
+## Status and released versions
+* Release 0.1.0 of guidelines and documentation for CAMARA APIs is available within the [release-0.1.0 branch](https://github.com/camaraproject/IdentityAndConsentManagement/tree/release-0.1.0)
+
+For changes see [CHANGELOG.md](https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/CHANGELOG.md)
 
 ## Contributorship and mailing list
 * To subscribe / unsubscribe to the mailing list of this Sub Project and thus be / resign as Contributor please visit <https://lists.camaraproject.org/g/sp-icm>.