1. Table of Contents
2. Project Overview
This project will develop the "code" part of the TM Forum Open APIs to be licensed under the Apache 2.0 license mode. This will include re-releasing API previously released under RAND. This project will work in close concert with the TM Forum Open API Program and will abide by its governance and use that groups output in the forms for specs, user stories, etc. to be the input to the development process. It is suggested that all members of the API Apache 2.0 project also be members of the API Project operating under the Core Project RAND Charter.
Although intelectual input will be taken from the specifications created under the RAND mode API Project, the specs themselves must not be contributed into this Apache 2.0 licence mode project, hence the assumption that Members of this project are also members of the API Project.
All contributions will implicitly carry the following notice statement:
Copyright © [copyright year] TM Forum. The TM Forum API Deliverables contained herein were contributed to the TM Forum by an Apache 2.0 License Mode Team and are subject to an Apache 2.0 License Mode Copyright Notice. No IPR was declared in the development of RAND License Mode TM Forum deliverables related to this TM Forum API Deliverable.
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
Contributors to this project are encouraged to review the TM Forum Intellicual Property Policy here: (Link to approved policy to be provided) to understand exactly what deliverables are acceptable to be license under Apache 2.0 License Mode.
3. User Stories
Provide a high-level description of how an end-user might use the output of the project.
If desired, copy and paste the table below to create multiple instances of the table and complete it for each user story.
| As a.. | |
| I need to... | |
| So that I can... | |
| To do this I need... |
4. Dependencies
Add in other projects and Frameworx dependencies this project will have. Please enter if your project will require INPUT FROM, produce OUTPUT TO or require JOINT WORKING with the named projects/Frameworx. In the COMMENTS column describe the nature of the input, output or joint working.
| Project_Name | INPUT_FROM OUTPUT_TO JOINT_WITH | COMMENTS (describe nature of Input/Output/Joint) |
|---|---|---|
| API Project | Input from | Specs, User Stories, etc - Specs will be developed by the API Project under RAND and the intelectual content passed to the API Apache 2.0 team members (frequently as Team Approved documents). |
| API Project | Output to | Once a file has been uploaded or edited in the tmforum-apis GitHub organisation, it its private WIP repo and an API-Apache project contribution made, to assert that the files are technically complete and ready for review, the WIP repo will be "promoted" to a public copy, that has world read permissions. This public copy is then ready for review by anyone, but especially the full API (RAND) project. |
| No others | All requirements gathering, catalyst evaluations, etc. will take place through the Open API Project, then the results of such dialogue feeds via that project to these machine readable artifacts. There is deliberately no interaction between this project and other projects apart from through the Open API Project. |
5. Participants
This section identifies the human resources and skills required by the project to successfully deliver the items listed in this charter. Unless otherwise noted, the level of commitment of all project participants is Best Effort.
At the time the charter is written, the individuals listed below are considered tentative participants. When the charter is approved, the tentative participants will be notified and they can “join” the project in the online community. From that point forward the project resources will be maintained and viewable in real time.
* indicates that this is a required field or role.
| Role | Name* (Confluence “@” mention) | Company* | Comments |
|---|---|---|---|
| Project Team Lead* | Stephen Harrop | Vodafone | |
| Project Co-Team Lead | Andreas Polz | Bearingpoint | |
| Mentor | |||
| Sponsor* | ATT, Orange, Vodafone | ||
| Observer | |||
| Reviewer | |||
| Subject Matter Expert | |||
| Workstream Lead | |||
| Staff | |||
Role Descriptions & Responsibilities given in section 11
6. Project Workstreams and Deliverables
Complete the migration of API swagger files from RAND to Apache 2.0 licence mode.
Optimise the creation of new Swagger files in Apache 2.0 licence mode.
6.01: API-Apache Processes & Governance
Workstream Leader: Stephen Harrop
| Ref # | Deliverable short name | Deliverable type/number | Description | Audience | Intended use | Plan for 1st 90 days | Plan for end of cycle | Sponsor / consumer support | Notes |
| 6.01.1 | Working Practices | Documents on Confluence | Develop working practices for manage Apache 2.0 licence mode artefacts | Open API development team members and the wider development community |
6.02. Migration of RAND licence mode code files to Apache 2.0 licence mode code files
Workstream Leader: Stephen Harrop
How do we ensure that the TM Forum Open APIs are brought to full implementation regarding the Apache 2.0 licence mode swagger, postman files?
| Ref # | Deliverable short name | Deliverable type/number | Description | Audience | Intended use | Plan for 1st 90 days | Plan for end of cycle | Sponsor / consumer support | Notes |
| 6.02.1 | Migrated RAND code files | Existing RAND code files to be identfied into batches and then to be team approved to be re-contributed into the API Apache 2.0 project |
We are seeking to migrate as many RAND swagger files (& Postman files, if we have them) from RAND to Apache 2.0 licence mode. The list below are the current candidates still to migrate, we have already got 10 APIs under the Apache 2.0 licence mode, the ambition is to migrate all (or as many as possible) of the 40 below also. This .pptx explains the migration: API_Apache_2.0_migration_v23.pptx. All the WIP private repos are set up at https://github.com/tmforum-apis and essentially the tasks for the swagger owner are:
- Join the API-Apache project
- Provide your GitHub ids
- Accept the invitation sent
- For each API
- Upload the swagger file to the corresponding WIP private repo
- Complete a contribution in the API-Apache project to state
- For API TMFnnn name, …
- The Swagger (and postman) are technically complete
- The Release it was last released under (e.g. R16.5) (I will tag this in GitHub)
- The Design Guidelines it is compatible with (e.g. DG2.0) (I will tag this in Git Hub)
- This should not take more than half an hour, assuming you have ready access to the correct information
- The JIRA record then authorises me to copy the WIP private repo to a public repo that everyone may see
| TMF# | API Name |
| 623 | SLA Management |
| 628 | Performance Management |
| 640 | Activation and Configuration |
| 642 | Alarm Management |
| 644 | Privacy Management |
| 649 | Performance Management Thresholding |
| 656 | Service Problem Management |
| 664 | Resource Function Activation and Configuration |
| 667 | Document Management |
| 670 | Payment Methods |
6.03. Creation of new Apache 2.0 licence mode code files
Workstream Leader: Stephen Harrop
How do we ensure that the TM Forum Open APIs are brought to full implementation regarding the Apache 2.0 licence mode swagger, postman files?
| Ref # | Deliverable short name | Deliverable type/number | Description | Audience | Intended use | Plan for 1st 90 days | Plan for end of cycle | Sponsor / consumer support | Notes |
| 6.03.1 | New Apaches 2.0 code files | New developments will create new code files directly in Apache 2.0 licence mode | |||||||
| 6.03.2 | |||||||||
| 6.03.3 |
7. Member Validation and Feedback Approach
Deliverables require validation and feedback. If the development team has a broad range of Members and Service Providers, validation may be within the team, however if the range of Members and Service Providers is weak, after Team Approval, deliverables must be validated beyond the team. Teams must state their Member & Validation approach here:
Validation Activity Approach | Deliverables will be reviewed and approved for review with the API Project within the API Apache 2.0 team. The API must be reviewed and approved by both the API Apache 2.0 Project and the API Project prior being formally approved as a TM Forum Draft Final Deliverable and submitted into formal Approval Process. It is anticipate to avoid creating excessive overhead the approval by the API Apache 2.0 Project may be by email or discussion post vote and the joint approval with the API Project team will be a formal detailed review. |
Validation Activity Description | Cross team meeting and deliverable review for following the appropriate patterns and adhering to API Project Governance |
Dependencies |
|
Comments |
8. Project Tooling
Indicate the tooling required for project success.
Product | Key Functions | Needed for Project? |
Confluence Space | Document creation and publishing | Provided by default |
JIRA Space | Contribution and feedback management | Provided by default |
GitHub | Code repository (if applicable) | This will be required |
Other Swagger Postman |
|
This will be required This will be required |
9. Liaison Relationships
Please indicate if this project has or plans to have a relationship with other External Standards Organizations (SDOs).
Name of Organization | Is this a New or Existing relationship? | Linkages and/or Scope of work | Contact person | Comments |
|---|---|---|---|---|
FiWare Linux Foundation/ONAP MEF
| Existing New Existing | API Users API Users API Users |
|
|
10. Charter History
11. Role Definition & Responsibilities
12. Legal Notice
Copyright © TM Forum 2018. All Rights Reserved.
This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to TM FORUM, except as needed for the purpose of developing any document or deliverable produced by a TM FORUM Collaboration Project Team (in which case the rules applicable to copyrights, as set forth in the TM FORUM IPR Policy, must be followed) or as required to translate it into languages other than English.
The limited permissions granted above are perpetual and will not be revoked by TM FORUM or its successors or assigns.
This document and the information contained herein is provided on an "AS IS" basis and TM FORUM DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Direct inquiries to the TM Forum office:
4 Century Drive, Suite 100
Parsippany, NJ 07054 USA
Tel No. +1 973 944 5100
Fax No. +1 973 944 5110
TM Forum Web Page: www.tmforum.org