From a6145ca7fffd818449acb9bd2188b7caf42de63d Mon Sep 17 00:00:00 2001
From: Herbert Damker <52109189+hdamker@users.noreply.github.com>
Date: Mon, 29 Jan 2024 08:11:29 +0100
Subject: [PATCH] Initial commit
---
.github/ISSUE_TEMPLATE/config.yml | 8 +
.../issue_correction_template.md | 21 ++
.../issue_documentation_template.md | 18 ++
.../issue_enhancement_template.md | 20 ++
.github/ISSUE_TEMPLATE/issue_pm_template.md | 18 ++
.../ISSUE_TEMPLATE/issue_tests_template.md | 18 ++
.github/pull_request_template.md | 45 ++++
CODEOWNERS | 9 +
GOVERNANCE.MD | 1 +
LICENSE | 201 ++++++++++++++++++
MAINTAINERS.MD | 3 +
README.md | 27 +++
code/API_definitions/README.MD | 1 +
code/Test_definitions/README.md | 1 +
documentation/API_documentation/README.MD | 1 +
documentation/MeetingMinutes/README.MD | 1 +
documentation/SupportingDocuments/README.MD | 1 +
17 files changed, 394 insertions(+)
create mode 100644 .github/ISSUE_TEMPLATE/config.yml
create mode 100644 .github/ISSUE_TEMPLATE/issue_correction_template.md
create mode 100644 .github/ISSUE_TEMPLATE/issue_documentation_template.md
create mode 100644 .github/ISSUE_TEMPLATE/issue_enhancement_template.md
create mode 100644 .github/ISSUE_TEMPLATE/issue_pm_template.md
create mode 100644 .github/ISSUE_TEMPLATE/issue_tests_template.md
create mode 100644 .github/pull_request_template.md
create mode 100644 CODEOWNERS
create mode 100644 GOVERNANCE.MD
create mode 100644 LICENSE
create mode 100644 MAINTAINERS.MD
create mode 100644 README.md
create mode 100644 code/API_definitions/README.MD
create mode 100644 code/Test_definitions/README.md
create mode 100644 documentation/API_documentation/README.MD
create mode 100644 documentation/MeetingMinutes/README.MD
create mode 100644 documentation/SupportingDocuments/README.MD
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..231c2d9
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+ - name: 🗣 Subproject discussions
+ url: https://github.com/camaraproject/§repo_name§/discussions
+ about: Please ask and answer questions here.
+ - name: 📖 CAMARA API Design Guidelines
+ url: https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md
+ about: Please refer to the design guidelines.
diff --git a/.github/ISSUE_TEMPLATE/issue_correction_template.md b/.github/ISSUE_TEMPLATE/issue_correction_template.md
new file mode 100644
index 0000000..488e70b
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/issue_correction_template.md
@@ -0,0 +1,21 @@
+---
+name: ❗ Correction 👣
+about: Suggest the correction of an issue in API specification or a misalignment with API design guidelines
+title: ''
+labels: 'correction'
+assignees: ''
+
+---
+
+**Problem description**
+
+
+**Expected behavior**
+
+
+
+**Alternative solution**
+
+
+**Additional context**
+
diff --git a/.github/ISSUE_TEMPLATE/issue_documentation_template.md b/.github/ISSUE_TEMPLATE/issue_documentation_template.md
new file mode 100644
index 0000000..f7b8de0
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/issue_documentation_template.md
@@ -0,0 +1,18 @@
+---
+name: ❕ Documentation 📝
+about: Indicate an issue with API documentation or supplementary documents
+title: ''
+labels: 'documentation'
+assignees: ''
+
+---
+
+**Problem description**
+
+
+**Expected action**
+
+
+
+**Additional context**
+
diff --git a/.github/ISSUE_TEMPLATE/issue_enhancement_template.md b/.github/ISSUE_TEMPLATE/issue_enhancement_template.md
new file mode 100644
index 0000000..279ce49
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/issue_enhancement_template.md
@@ -0,0 +1,20 @@
+---
+name: 💡 Enhancement 🌟
+about: Suggest an idea for a new API feature or pose a question on directions for API evolution
+title: ''
+labels: 'enhancement'
+assignees: ''
+
+---
+
+**Problem description**
+
+
+**Possible evolution**
+
+
+**Alternative solution**
+
+
+**Additional context**
+
diff --git a/.github/ISSUE_TEMPLATE/issue_pm_template.md b/.github/ISSUE_TEMPLATE/issue_pm_template.md
new file mode 100644
index 0000000..210a2f0
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/issue_pm_template.md
@@ -0,0 +1,18 @@
+---
+name: ☁ Subproject management 🎂
+about: Indicate an issue with subproject repository or release management
+title: ''
+labels: 'subproject management'
+assignees: ''
+
+---
+
+**Problem description**
+
+
+**Expected action**
+
+
+
+**Additional context**
+
diff --git a/.github/ISSUE_TEMPLATE/issue_tests_template.md b/.github/ISSUE_TEMPLATE/issue_tests_template.md
new file mode 100644
index 0000000..170874a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/issue_tests_template.md
@@ -0,0 +1,18 @@
+---
+name: ⁉ Tests 🔎
+about: Indicate an issue with API tests
+title: ''
+labels: 'tests'
+assignees: ''
+
+---
+
+**Problem description**
+
+
+**Expected action**
+
+
+
+**Additional context**
+
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000..37952b5
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,45 @@
+#### What type of PR is this?
+
+Add one of the following kinds:
+* bug
+* correction
+* enhancement/feature
+* cleanup
+* documentation
+* subproject management
+* tests
+
+
+#### What this PR does / why we need it:
+
+
+
+
+#### Which issue(s) this PR fixes:
+
+
+
+Fixes #
+
+#### Special notes for reviewers:
+
+
+
+#### Changelog input
+
+```
+ release-note
+
+```
+
+#### Additional documentation
+
+This section can be blank.
+
+
+
+```
+docs
+
+```
diff --git a/CODEOWNERS b/CODEOWNERS
new file mode 100644
index 0000000..672865d
--- /dev/null
+++ b/CODEOWNERS
@@ -0,0 +1,9 @@
+# This file provides an overview of code owners in this repository.
+
+# Each line is a file pattern followed by one or more owners.
+# The last matching pattern has the most precedence.
+# For more details, read the following article on GitHub: https://help.github.com/articles/about-codeowners/.
+
+# These are the default owners for the whole content of this repository. The default owners are automatically added as reviewers when you open a pull request, unless different owners are specified in the file.
+
+
diff --git a/GOVERNANCE.MD b/GOVERNANCE.MD
new file mode 100644
index 0000000..bce399b
--- /dev/null
+++ b/GOVERNANCE.MD
@@ -0,0 +1 @@
+This repository follows the governance and rules defined in the "Governance" repository of the Project.
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..261eeb9
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/MAINTAINERS.MD b/MAINTAINERS.MD
new file mode 100644
index 0000000..dc1870b
--- /dev/null
+++ b/MAINTAINERS.MD
@@ -0,0 +1,3 @@
+| Org | Name |
+| -----------------------| ----------------------------------------------------|
+| §company§ | $name§ |
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f0090fb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+
+
+
+
+
+
+
+# §repo_name§
+Repository to describe, develop, document and test the §repo_name§ API family
+
+## Scope
+* Service APIs for “§repo_name§” (see APIBacklog.md)
+* It provides the customer with the ability to:
+ * §API family description§.
+ * NOTE: The scope of this API family should be limited (at least at a first stage) to 4G and 5G.
+* Describe, develop, document and test the APIs (with 1-2 Telcos)
+* Started: §start date§
+* Location: virtually
+
+## Meetings
+* Meetings are held virtually
+* Schedule: tbd
+* Meeting link: tbd
+
+## Contributorship and mailing list
+* To subscribe / unsubscribe to the mailing list of this Sub Project and thus be / resign as Contributor please visit .
+* A message to all Contributors of this Sub Project can be sent using .
diff --git a/code/API_definitions/README.MD b/code/API_definitions/README.MD
new file mode 100644
index 0000000..04313f1
--- /dev/null
+++ b/code/API_definitions/README.MD
@@ -0,0 +1 @@
+Here you can add your definitions and delete this README.MD file
diff --git a/code/Test_definitions/README.md b/code/Test_definitions/README.md
new file mode 100644
index 0000000..27a1f06
--- /dev/null
+++ b/code/Test_definitions/README.md
@@ -0,0 +1 @@
+This directory contains at least one `.feature` file containing test definitions for the repository API(s).
diff --git a/documentation/API_documentation/README.MD b/documentation/API_documentation/README.MD
new file mode 100644
index 0000000..37aa0ff
--- /dev/null
+++ b/documentation/API_documentation/README.MD
@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.
diff --git a/documentation/MeetingMinutes/README.MD b/documentation/MeetingMinutes/README.MD
new file mode 100644
index 0000000..37aa0ff
--- /dev/null
+++ b/documentation/MeetingMinutes/README.MD
@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.
diff --git a/documentation/SupportingDocuments/README.MD b/documentation/SupportingDocuments/README.MD
new file mode 100644
index 0000000..37aa0ff
--- /dev/null
+++ b/documentation/SupportingDocuments/README.MD
@@ -0,0 +1 @@
+This README.MD can be deleted when the first file is added to this directory.