Versions Compared

Old Version 15

changes.mady.by.user Dana Bobko

Saved on

compared with

New Version 16

changes.mady.by.user Dana Bobko

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated SG-5, added Rich B

...

NameCompanyEmailPhone NumberTime Zone
Rich Bennett AT&T    

Dana Bobko*

AT&Tdw2049@att.com(561) 371-7619EST

Sharon Chisholm

AMDOCSsharon.chisholm@amdocs.com 
EST

Chris Donley

Huawei Christopher.Donley@huawei.com 

Gregory Glover

AT&Tgg2147@att.com  (847) 420-8459 
Mark HoAT&T mh574f@att.com  (781) 791-4345EST 

Ramki Krishnan

VMware ramkik@vmware.com 

Andy Mayer 

AT&T am803u@att.com  EST 

Adolfo Perez-Duran

ARM (OAM)adolfo.perez-duran@oamtechnologies.com 720.560.2659MT

Alexander Vul

Intel alex.vul@intel.com 

Parviz Yegani

Huawei Parviz.Yegani@huawei.com (408) 759-1973PT

...

Spec ID

Specification/RequirementSpe

SG-1All components shall use Swagger 2.0. The specification may be found here. OpenAPI 3.0 is a roadmap item.
SG-2

Within the Info Object, the following annotations are included in the Swagger specification and shall be required, even if they are optional in the Swagger spec:

title

description

version - fully-qualified version number of the Swagger file (ex: 1.4.18)

SG-3 

Within the Info Object, the following are extensions of the Swagger specification and shall be required:

x-planned-retirement-date - use YYMM; string type. This is the date that the API shall be deprecated, based on the BWC Policy. NOTE: APIs may be active after their retirement date, but are not guaranteed to remain in production. An API retirement may be pushed out to accommodate BWC for clients.

x-component - SDC, MSO, SNIRO, etc., or the mS name; string type. This is the component that owns the API.

SG-4

Under the Path, the following shall be required:

x-interface info - this contains two attributes:

      • api-version - fully-qualified version number of the API (ex: 1.3.6); string type. This is the version of the API. This differs from the version in SG-2 above. Components shall follow the Versioning Use Cases above to determine how to evolve API versions.
      • last-mod-release - use release number or name (this should be consistent, choose either one); string type. This is the last release that the API was modified in. 
SG-5 

Swagger files shall be generated at build time, and be placed in a centralized CodeCloud ReadTheDocs repository located at: TBD: http://docs.onap.org

SG-6 

Within the Path Item Object, the following are included in the Swagger specification and shall be required: 

description - string

parameters

      • required - boolean
      • type - string

...