Versions Compared

Old Version 2

changes.mady.by.user Andy Mayer

Saved on

compared with

New Version 3

changes.mady.by.user Jonathan Gathman

Saved on

Key

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



None

Project NameProject Tech. LeadModels and API Specs
1A & AI

James Forsyth 

AAI REST API Documentation - Dublin
2Application Authorization Framework

Jonathan Gathman

https://aaf-onap-test.osaaf.org:8200/gui/api

(WinRiver)


3APPC

Takamune Cho

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.

4CLAMP

 Gervais-Martial Ngueko

CLAMP teams plans on providing the information
5Common Controller SDK

Dan Timoney

In progress


6DCAE

Vijay Kumar


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

7DMaaP
Ramprasad Koya

waiting on modeling team.

DMaaP MR API

DMaaP BusController API

DMaaP DataRouter API

8Documentation

Sofia Wallin

N/A
9External API Framework

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

10Holmes

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

11

Integration

Yang Xu

N/A
12

Logging Enhancements Project

Including POMBA

Michael O'Brien

No swagger API data

Logging Developer Guide

Active Logging Specifications

13Microservices Bus

Former user (Deleted)

Microservice Bus API Documentation
14Modeling

Hui Deng

None
15Multi VIM/Cloud

Bin Yang

Need to add Modeling checklist item

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

16MUSIC

bharathb

https://gerrit.onap.org/r/#/c/31127/2/swagger.json
17ONAP CLI

Former user (Deleted)

Need to update the checklist including Modeling

Dublin M3 Interface details

18ONAP Operations Manager

Mike Elliott

OOM provides no external API's.
19ONAP Optimization Framework
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:

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

20ONAP Usecase UI

Tao Shen

N/A
21Policy Framework

Pamela Dragosh

Policy Design and API Flow for Model Driven Control Loop
22Portal Platform

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

23SDN-C

Dan Timoney

In Progress

SDNC API documentation in readthedocs

24Service Design & Creation

Ofir Sonsino

No Template

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

25Service Orchestrator

Seshu Kumar Mudiganti

https://onap.readthedocs.io/en/latest/submodules/so.git/docs/api/offered_consumed_apis.html
26VF-C: Virtual Function Controller

Yan Yang

To Do

nslcm-swagger.yaml

catalog-swagger.yaml

27VID project

ittay

No Template

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

28VNF SDK

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.

VNFSDK provide the swagger here : Marketplace

29VNF Requirements

Steven wright

N/A
30VNF Validation (VVP)

Steven wright

no APIs

vvp docs

...