Merge pull request #23 from ShutingQing/main

Add changelog and gitignore file

.gitignore

@@ -0,0 +1,32 @@
+.DS_Store
+
+### Generated files ###
+target/
+logs/
+
+### STS ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+build/
+
+### VS Code ###
+.vscode/
+.unotes/

CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+## X.Y.Z [ALPHA] - YYYY-MM-DD
+
+### Added
+
+* New property `new_name`
+* New endpoint `new_name`
+* Examples
+
+### Changed
+
+* Property `old_name` renamed to `new_name`
+* Format for property `property` changed to `new_format`
+
+### Fixed
+
+* Typos fixed
+* Reference corrected
+
+### Removed
+
+* Deprecated field `old_field`
+* Deprecated endpoint

README.md

@@ -9,17 +9,24 @@
 Repository to describe, develop, document and test the Identity And Consent Management API family
 
 ## Scope
-* Service APIs for “IdentityAndConsentManagement” (see APIBacklog.md)  
-* Operator (NaaS) platform implementing CAMARA APIs should be built with a privacy-by-default approach to fully comply with data protection regulations like the GDPR regulation in Europe, which emphasises on user's privacy. These regulations note that some CAMARA APIs may require user consent to be accessed. This forces the operators to provide means and appropriate solutions to capture, store and manage this consent through its lifecycle. Otherwise, the scoped CAMARA APIs cannot be rolled out in production networks. Building such a solution also means bringing in scope the identity of the end user and/or the subscriber (as both could be different) and making sure that end user experience of using the API is not compromised while doing so.
+* Service APIs for “IdentityAndConsentManagement” (see [APIBacklog.md](https://github.com/camaraproject/WorkingGroups/blob/main/APIBacklog/documentation/APIBacklog.md))  
+* Telco Operator Exposure platforms implementing CAMARA APIs should be built with a privacy-by-default approach to fully comply with data protection regulations, such as the GDPR regulation in Europe, which emphasises on user privacy. These regulations note that some CAMARA APIs may require user consent to be accessed. This forces the operators to provide means and appropriate solutions to capture, store and manage this consent through its lifecycle. Otherwise, the scoped CAMARA APIs cannot be rolled out in production networks. Building such a solution also means bringing in scope the identity of the end user and/or the subscriber (as both could be different) and making sure that end user experience of using the API is not compromised while doing so
 * Describe, develop, document and test the APIs (with 1-2 Telcos)  
 * Started: March 2023
 * Location: virtually
 
 ## Meetings
 * Meetings are held virtually
-* 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. 
+* 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)
+
 ## 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>.
 * A message to all Contributors of this Sub Project can be sent using <[email protected]>.
+

documentation/API_documentation/README.MD

@@ -1 +1 @@
-This README.MD can be deleted when the first file is added to this directory.
+Here you can add your definitions and delete this README.MD file

documentation/MeetingMinutes/README.MD

@@ -1 +1,30 @@
-This README.MD can be deleted when the first file is added to this directory.
+# Meeting Details
+
+### Biweekly Meeting
+
+Wednesday ---> 4 PM CET/CEST
+
+### Meeting Link
+
+[Microsoft 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)
+
+### Upcoming Meetings
+
+| Date       |
+|------------|
+| 2023/05/31 |
+| 2023/06/14 |
+| 2023/06/28 |
+| 2023/07/12 |
+| 2023/07/26 |
+| 2023/08/09 |
+| 2023/08/23 |
+
+
+### MoMs
+
+2023/03/22 [Notes](MOM-2023-03-22.md)
+
+2023/04/12 [Notes](MOM-2023-03-22.md)
+
+2023/05/03 [Notes](MOM-2023-05-03.md)