Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.



Project NameProject Tech. LeadModels and API SpecsIM CategoryExisting ModelGapModeling Priority
1A & AI AAI REST API Documentation - Dublinresource & 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


2Application Authorization Framework

AAF RESTful API Docs - Realtime

(WinRiver)


TBD


3APPC

APPC provides one single definition for API: 
APPC API GUIDE

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.

resourcenone

4CLAMPCLAMP teams plans on providing the informationresource/common?none

5Common Controller SDK

In progress


resourcenone

6DCAE

Datamodel used by DCAE service components is VES

https://onap.readthedocs.io/en/latest/submodules/dcaegen2.git/docs/sections/apis/deployment-handler.html

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

commonVES model to be documented in R5: VES 7.1

7DMaaP

waiting on modeling team.

DMaaP MR API

DMaaP BusController API

DMaaP DataRouter API

TBD


8DocumentationN/AN/AN/A

9External API Framework

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 serviceservice orderno models accepted for service inventory
10Holmes

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

Integration

N/AN/AN/A

12

Logging Enhancements Project

Including POMBA

No swagger API data

Logging Developer Guide

Active Logging Specifications

TBD (common?)none

13Microservices BusMicroservice Bus API DocumentationTBD


14ModelingNoneN/AN/A

15Multi VIM/Cloud

Need to add Modeling checklist item

https://onap.readthedocs.io/en/latest/submodules/multicloud/framework.git/docs/MultiCloud-APIv1-Specification.html

Infrastructure


16MUSIChttps://gerrit.onap.org/r/#/c/31127/2/swagger.jsonTBD


17ONAP CLI

Need to update the checklist including Modeling

Dublin M3 Interface details

TBD


18ONAP Operations ManagerOOM provides no external API's.N/AN/A

19ONAP Optimization Framework

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:

Topology Service API Swagger

CM Ticket Management API Swagger

Change Management (CM) Schedule Optimizer API Swagger

HAS:

oof-has-api.json

OSDF:

oof-osdf-has-api.json

TBD


20ONAP Usecase UIN/AN/AN/A

21Policy FrameworkPolicy Design and API Flow for Model Driven Control Loopcommonpolicy model (draft in R4): Policy Draftpolicy framework has updated their model in R4
22Portal Platform

Need to update the checklist including Integration & Modeling Checklist items

https://docs.onap.org/en/beijing/submodules/portal.git/docs/platform/offeredapis.html

N/AN/A

23SDN-C

In Progress

SDNC API documentation in readthedocs

resourcenone

24Service Design & Creation

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:

Composite / Atomic Service

service model with filter mechanism:

Enhanced Service Information Model for Nested and Shared Services




Heat model not documented



25Service Orchestratorhttps://onap.readthedocs.io/en/latest/submodules/so.git/docs/api/offered_consumed_apis.htmlservice

service descriptor,

composite service structure:

Composite / Atomic Service

service order?

SO hasn't supported composite service model.

High
26VF-C: Virtual Function Controller

To Do

nslcm-swagger.yaml

catalog-swagger.yaml

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)



27VID project

No Template

https://onap.readthedocs.io/en/latest/submodules/vid.git/docs/offeredapis.html

service&resourcenone

28VNF SDK

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.

VNFSDK provide the swagger here : Marketplace

resource

onboarding VNFD model documented in R4: Updated V2.5.1 VNFD Model

onboarding PNFD model documented in R4: Agreed PNFD Model

non-MANO artifact: ONAP Non-MANO Artifacts Set Identifiers



29VNF RequirementsN/ATBD


30VNF Validation (VVP)

no APIs

vvp docs

resourcenone

...