generated from camaraproject/Template_API_Repository
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3 from camaraproject/hdamker-patch-1
Update README.md
- Loading branch information
Showing
1 changed file
with
21 additions
and
27 deletions.
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 |
|---|---|---|
| @@ -1,42 +1,36 @@ | ||
| <a href="https://github.com/camaraproject/§repo_name§/commits/" title="Last Commit"><img src="https://img.shields.io/github/last-commit/camaraproject/§repo_name§?style=plastic"></a> | ||
| <a href="https://github.com/camaraproject/§repo_name§/issues" title="Open Issues"><img src="https://img.shields.io/github/issues/camaraproject/§repo_name§?style=plastic"></a> | ||
| <a href="https://github.com/camaraproject/§repo_name§/pulls" title="Open Pull Requests"><img src="https://img.shields.io/github/issues-pr/camaraproject/§repo_name§?style=plastic"></a> | ||
| <a href="https://github.com/camaraproject/§repo_name§/graphs/contributors" title="Contributors"><img src="https://img.shields.io/github/contributors/camaraproject/§repo_name§?style=plastic"></a> | ||
| <a href="https://github.com/camaraproject/§repo_name§" title="Repo Size"><img src="https://img.shields.io/github/repo-size/camaraproject/§repo_name§?style=plastic"></a> | ||
| <a href="https://github.com/camaraproject/§repo_name§/blob/main/LICENSE" title="License"><img src="https://img.shields.io/badge/License-Apache%202.0-green.svg?style=plastic"></a> | ||
| <a href="https://github.com/camaraproject/§repo_name§/releases/latest" title="Latest Release"><img src="https://img.shields.io/github/release/camaraproject/§repo_name§?style=plastic"></a> | ||
| <a href="https://github.com/camaraproject/SubscriptionStatus/commits/" title="Last Commit"><img src="https://img.shields.io/github/last-commit/camaraproject/SubscriptionStatus?style=plastic"></a> | ||
| <a href="https://github.com/camaraproject/SubscriptionStatus/issues" title="Open Issues"><img src="https://img.shields.io/github/issues/camaraproject/SubscriptionStatus?style=plastic"></a> | ||
| <a href="https://github.com/camaraproject/SubscriptionStatus/pulls" title="Open Pull Requests"><img src="https://img.shields.io/github/issues-pr/camaraproject/SubscriptionStatus?style=plastic"></a> | ||
| <a href="https://github.com/camaraproject/SubscriptionStatus/graphs/contributors" title="Contributors"><img src="https://img.shields.io/github/contributors/camaraproject/SubscriptionStatus?style=plastic"></a> | ||
| <a href="https://github.com/camaraproject/SubscriptionStatus" title="Repo Size"><img src="https://img.shields.io/github/repo-size/camaraproject/SubscriptionStatus?style=plastic"></a> | ||
| <a href="https://github.com/camaraproject/SubscriptionStatus/blob/main/LICENSE" title="License"><img src="https://img.shields.io/badge/License-Apache%202.0-green.svg?style=plastic"></a> | ||
| <a href="https://github.com/camaraproject/SubscriptionStatus/releases/latest" title="Latest Release"><img src="https://img.shields.io/github/release/camaraproject/SubscriptionStatus?style=plastic"></a> | ||
|
|
||
| # §repo_name§ | ||
| Repository to describe, develop, document, and test the §repo_name§ API within the [§Sub Project§](https://wiki.camaraproject.org/display/CAM/Sub+Projects) of CAMARA | ||
| !! Replace the link with the link to the home page of the Sub Project and delete this task | ||
| <!-- Alternative if the first repository of a new API Sub Project and/or it contains multiple APIs | ||
| "Repository to describe, develop, document, and test the APIs of the $Sub Project$ Sub Project" --> | ||
| <!-- Alternative if the repository will be used for a working group - in this case further points, e.g. the scope, of this template need to be adapted | ||
| "Repository for xxx of the $Working Group$ Working Group" --> | ||
| # SubscriptionStatus | ||
| Repository to describe, develop, document, and test the SubscriptionStatus API within the Sub Project [KnowYourCustomer](https://wiki.camaraproject.org/x/8AKeAQ) of CAMARA | ||
|
|
||
| ## Scope | ||
|
|
||
| * Service API “§repo_name§” (see APIBacklog.md) <!-- Alternative for multiple APIs: "Service APIs for "§repo_name§” --> | ||
| * Service API “SubscriptionStatus” (see [APIBacklog.md](https://github.com/camaraproject/APIBacklog/blob/main/documentation/APIbacklog.md)) | ||
| * The API provides the customer with the ability to: | ||
| * §Short API scope description§ | ||
| * obtain the current subscription status of a certain phone number, including the subscription of Voice/SMS in, Voice/SMS out, and data service | ||
| * Describe, develop, document, and test the APIs | ||
| * Started: §start date§ | ||
| * Started: August 2024 | ||
|
|
||
| ## Release Information | ||
|
|
||
| The repository has no (pre)releases yet, work in progress is within the main branch. | ||
| <!-- Optional: an explicit listing of the latest (pre-)release with additional information, e.g. links to the API definitions --> | ||
| <!-- In addition use/uncomment one or multiple the following alternative options when becoming applicable --> | ||
| <!-- Pre-releases of this sub project are available in https://github.com/camaraproject/§repo_name§/releases --> | ||
| <!-- The latest public release is available here: https://github.com/camaraproject/§repo_name§/releases/latest --> | ||
| <!-- For changes see [CHANGELOG.md](https://github.com/camaraproject/§repo_name§/blob/main/CHANGELOG.md) --> | ||
| <!-- Pre-releases of this sub project are available in https://github.com/camaraproject/SubscriptionStatus/releases --> | ||
| <!-- The latest public release is available here: https://github.com/camaraproject/SubscriptionStatus/releases/latest --> | ||
| <!-- For changes see [CHANGELOG.md](https://github.com/camaraproject/SubscriptionStatus/blob/main/CHANGELOG.md) --> | ||
|
|
||
| ## Contributing | ||
| * Meetings are held virtually <!-- for new API families request a meeting link from the LF admin team or replace the information with the existing meeting information (of the API family) --> | ||
| * Schedule: !! tbd | ||
| * [Registration / Join](https://wiki.camaraproject.org/x/TQAG) !! Update this link with your meeting registration/join link | ||
| * Minutes: Access [meeting minutes] !! update this link to your wiki page using the "Share" link | ||
| * Meetings of Sub Project KnowYourCustomer are held virtually | ||
| * Schedule: Bi-weekly, Tuesday, 09:00 CEST (07:00 UTC) | ||
| * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/96235150735?password=7e3fea67-a76e-4941-8a70-392cf5545917) | ||
| * Minutes: Access [meeting minutes](https://wiki.camaraproject.org/display/CAM/KnowYourCustomer+Meeting+Minutes) | ||
| * Mailing List | ||
| <!-- Note: the $sub-project-mailinglistname$ is either already existing or will be created by the CAMARA Admin Team --> | ||
| * Subscribe / Unsubscribe to the mailing list of this Sub Project <https://lists.camaraproject.org/g/sp-§sub-project-mailinglistname§>. | ||
| * A message to the community of this Sub Project can be sent using <sp-§sub-project-mailinglistname§@lists.camaraproject.org>. | ||
| * Subscribe / Unsubscribe to the mailing list of this Sub Project <https://lists.camaraproject.org/g/sp-kyc>. | ||
| * A message to the community of this Sub Project can be sent using <sp-kyc@lists.camaraproject.org>. |