ONAP R4+ Per-Project Models and API Specs
Project Name | Project Tech. Lead | Models and API Specs | IM Category | Existing Model | Gap | Modeling Priority | |
---|---|---|---|---|---|---|---|
1 | @James Forsyth | resource & service | 1.VNF instance model is documented in R3: R3 Resource Clean Draft (Papyrus Based) 2. R3 Service Model &R3 Network Service Model | AAI model contains more models than those currently documented | High | ||
2 | @Jonathan Gathman | AAF RESTful API Docs - Realtime (WinRiver) | TBD | ||||
3 | @Takamune Cho | APPC provides one single definition for API: APPC uses Yang model to define LCM Action: Yang Model for LCM Action for payload. APPC uses swagger 1.2 apidoc that provided by ODL ( see some sample links in APPC WindRiverLab ) APPC does not use TOSCA model in R4. | resource | none | |||
4 | @Gervais-Martial Ngueko | CLAMP teams plans on providing the information | resource/common? | none | |||
5 | @Dan Timoney | In progress | resource | none | |||
6 | @Vijay Kumar | Datamodel used by DCAE service components is VES https://onap.readthedocs.io/en/latest/submodules/dcaegen2.git/docs/sections/apis/inventory.html https://onap.readthedocs.io/en/latest/submodules/dcaegen2.git/docs/sections/apis/dcaecdap.html https://git.onap.org/dcaegen2/services/prh/tree/swagger.yaml https://git.onap.org/dcaegen2/collectors/ves/tree/swagger_vescollector_1.3.1.yaml https://git.onap.org/dcaegen2/platform/configbinding/tree/app/app/swagger.yaml RESTConf - https://git.onap.org/dcaegen2/collectors/restconf/tree/swagger_restconfcollector_1.0.0.yaml | common | VES model to be documented in R5: VES 7.1 | |||
7 | @Ramprasad Koya | waiting on modeling team. | TBD | ||||
8 | @Sofia Wallin | N/A | N/A | N/A | |||
9 | @Matthieu Geerebaert | Each API resources is documented with swagger, as json or yaml, and each data model is also described as plantuml and xml schemas Here the master readthedoc sources ( not yet build and available online ) https://git.onap.org/externalapi/nbi/tree/docs/offeredapis/api_serviceOrder https://git.onap.org/externalapi/nbi/tree/docs/offeredapis/api_hub https://git.onap.org/externalapi/nbi/tree/docs/offeredapis/api_serviceInventory https://git.onap.org/externalapi/nbi/tree/docs/offeredapis/api_status | currently service | service order | no models accepted for service inventory | Medium | |
10 | @Guangrong Fu | The data models are described inside the API doc: Holmes API Documentation - Dublin Also, you could find the corresponding Swagger files here: https://gerrit.onap.org/r/gitweb?p=holmes/rule-management.git;a=blob;f=api/swagger.json https://gerrit.onap.org/r/gitweb?p=holmes/engine-management.git;a=blob;f=api/swagger.json | TBD | ||||
11 | @Yang Xu | N/A | N/A | N/A | |||
12 | Including POMBA | @Michael O'Brien | No swagger API data | TBD (common?) | none | ||
13 | @Former user (Deleted) | TBD | |||||
14 | @Hui Deng | None | N/A | N/A | |||
15 | @Bin Yang | Need to add Modeling checklist item | Infrastructure | ||||
16 | @bharathb | TBD | |||||
17 | @Former user (Deleted) | Need to update the checklist including Modeling | TBD | ||||
18 | @Mike Elliott | OOM provides no external API's. | N/A | N/A | |||
19 | @Shankaranarayanan Puzhavakath Narayanan | API models has been documented in swagger. However, OOF is indirectly consuming service and data models, especially for the service instantiation workflows, either directly (by querying AAI, MultiCloud) or indirectly (Policy, SO). Components like OSDF and HAS captures this information in their internal models that may have different terminologies - OPTFRA-261 - Align SO-OOF API to use ONAP wide instance invariant service identifier OPEN CMSO: CM Ticket Management API Swagger Change Management (CM) Schedule Optimizer API Swagger HAS: OSDF: | TBD Potential related to service and resource, need to discuss with SO and OOF team | ||||
20 | @Tao Shen | N/A | N/A | N/A | |||
21 | @Pamela Dragosh | common | policy model (draft in R4): Policy Draft | policy framework has updated their model in R4 | |||
22 | @Manoop Talasila | Need to update the checklist including Integration & Modeling Checklist items https://docs.onap.org/en/beijing/submodules/portal.git/docs/platform/offeredapis.html | N/A | N/A | |||
23 | @Dan Timoney | In Progress | resource | none | |||
24 | @Ofir Sonsino | No Template https://onap.readthedocs.io/en/latest/submodules/sdc.git/docs/offeredapis.html | resource&service | onboarding VNFD model documented in R4: Updated V2.5.1 VNFD Model onboarding PNFD model documented in R4: Agreed PNFD Model service descriptor, composite service structure: service model with filter mechanism: Enhanced Service Information Model for Nested and Shared Services | Heat model not documented Need comparision between current composite model and SDC model. @Kevin Scaggs @Ofir Sonsino @Anatoly Katzman | High for Service model | |
25 | @Seshu Kumar Mudiganti | https://onap.readthedocs.io/en/latest/submodules/so.git/docs/api/offered_consumed_apis.html | service | service descriptor, composite service structure: service order? | SO hasn't supported composite service model. | High | |
26 | @Yan Yang | To Do | resource | onboarding VNFD model documented in R4: Updated V2.5.1 VNFD Model VNF instance model is documented in R3: R3 Resource Clean Draft (Papyrus Based) | |||
27 | @ittay | No Template https://onap.readthedocs.io/en/latest/submodules/vid.git/docs/offeredapis.html | service&resource | none | |||
28 | @victor gao | VNFSDK use ONAP R4+ Onboarding PNFD based on ETSI NFV SOL001 to do the PNF pre-onboarding/validation VNFSDK also use tosca model to do the compliance check. |