generated from camaraproject/Template_API_Repository
-
Notifications
You must be signed in to change notification settings - Fork 32
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
Add changelog and gitignore file #23
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
ed39df5
Add some docs
ShutingQing ac9894d
renew gitignore
ShutingQing 9cc355b
add changelog content
ShutingQing 13cf363
update version num to v0.1.0 wip
ShutingQing 60eab00
fix changelog name
ShutingQing 06f31bf
update changelog to template and remove placeholder readme content
ShutingQing 4ecf0ff
Update README.md
rartych dcbd8e9
Update README.MD
rartych File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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]>. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will require us to update this README every time we add a meeting minutes document.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks good, thanks.