Versions Compared

Key

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

...

Issue 1 - Parsing of YAML file into RST format

Richard Epp to send yaml file via email to Pavel and attach to wiki so all can see.

YAML file too large and resulting RST file cannot be read by readmedoc causing it to be unusable.

Issues parsing the YAML file into RST format - structure is not correct - structure of YAML file must follow SWAGGER structure.

Issue 2 - Exposing AAI Swagger through MSB

Suggestion of using MSB portal with link of file to readmedoc.

How to display REST APIs via the swagger UI integrated with MSB: https://wiki.onap.org/display/DW/Microservice+Bus+API+Documentation#MicroserviceBusAPIDocumentation-APIDefinitionandSwagger-UI

Will need to continue as open item until resolved.

Contact Zi Li / Former user (Deleted) for more information about integration. Just require the swagger JSON file for integration - Richard Epp please provide the JSON to Zi Li -

https://wiki.onap.org/display/DW/2018-02-02+AAI+Weekly+Meeting+notes?preview=%2F25429783%2F25432551%2FNetwork_v13.yaml

Zi Li - please download the yaml file above and see if you can make use of it in MSB

Note: Alternate Swagger UI service already available.

Huabing - Please refer to the below comments for session sticky and AAF plugin progress

2018-02-16: Generator of the RST can't find the definitions (there is a getDefinitions and patchDefinitions) and parser can't deal with it. Generator only can parse ASCII and there are characters outside the ASCII set. PATCH and GET methods can possibly be split into their own files. Richard Epp will look into installing swagger UI in Windriver lab; Venkata Harish Kajur knows how to access, contact Stephen Gooch for access

23 Feb:

Richard Epp split up the files; James Forsyth uploaded network put and get (RST files) which Passed.  Will do REST next.

Richard Epp to get access to JIRA (LF)

Venkata Harish Kajur to provide guidance to Richard Epp on setting up Dev env locally.

2 March: Richard Epp uploaded all RST files to wiki yesterday; not able to run GET commands, will work on Permissions issue.

Update 8 March: Richard Epp was OOO this week, need to close on this one soon. Also need to regenerate based on the current v13 schema files (including pending commits that aren't merged yet)

Update 16 March: Follow-up needed with Richard Epp

Update 21 March: Richard Epp will add to Gerrit before next Thu in time before M4; will use git review.  He will reach out to James Forsyth if any issues encountered.

Update 4 April: Richard Epp and Rich Bennett discussed, no path forward.  James Forsyth to ask for continued exception for our documentation.  James Forsyth to create US for v12 versus v13.

Update 17 April: New format for Casablanca, we might do it for Beijing because it works better for us: Example New Offereapis Page


Code Coverage Policy Enforcement

For aai-common, resources, and traversal we've enabled jacoco threshold to make sure that code coverage doesn't fall on a commit. This will prevent users from contributing code that would negatively impact the overall code coverage on a repo. Let's discuss enabling this across the board on all AAI repos.

Update 11 April: James Forsyth and Venkata Harish Kajur - Look at automated PoC polling script, add test coverage.

Update 13 June: Code coverage for Casablanca expected to be 70 - 80% level.


CII Badging

Wiki page with instructions on the process: CII Badging Program

We have two CII Badging submissions currently active on CII Best Practice Badge Program: 1) AAI and 2) Sparky-fe

The team needs to decide how to split up the project - AAI is too big to fit under a single project.  James Forsyth proposes the following breakdown for CII badging:

1) AAI core (REST providers and common code): James Forsyth - Project created, ongoing progress.

  • aai-common
  • aai-resources
  • aai-traversal
  • gizmo
  • champ
  • graphadmin
  • event-client

2) GUI - Arul Nambi - Need to include more repos to the current "front-end" project

  • sparky-fe
  • sparky-be
  • data-router
  • search-data-service
  • router-core

3) Model loader - Tian Lee / Mark Tooski- Need to create projects

  • model-loader
  • babel

  • 4) Graph utils / eventing / logging - Steve Blimkie - Need to create projects
  • spike
  • gap - Tian Lee
  • graphgraph - Stretch for Beijing
  • event-client - Tian Lee
  • rest-client

4) ESR - Zi Li - Project is created, still ongoing process to meet all the requirements

  • esr-gui
  • esr-server


The idea is that we assign one key person who will be responsible for getting the badge on their set of repos.  This is just a suggestion, and I invite discussion, re-categorization, and complete rewrites. Owners of the sets can decide whether it makes sense to group sets into one CII badging request, or split. Every repo above must be included in 1 CII submission.

23 Feb:

Need readout next week per repo as to where we stand and how we can close before M4 (3/29).

Zi Li and Arul Nambi will work together to see if same kind of scan will work for both components

2 March: SONAR will not report on java script based so those need to be run manually via another tool locally.

Update 3/8: Urgent - need to document our plan and have a commitment to get to 50% coverage by m4. Preferably sooner to prevent giving your PTL a heart attack.

Offending repos:

ALSO: if your repo is part of Beijing but is NOT part of the SONAR scan, (Venkata Harish Kajur, graphadmin leaps to mind) please fix that ASAP

Update 9 March: Steve Blimkie needs James Forsyth’s signoff on moving small libraries within event and rest clients to aai.core; Spike and Gap not used in Beijing;  Tian Lee to create project for Model loader; may need secondary URL describing model-loader but point to aai.core.

Gizmo – Giulio Graziani requesting adding it to his team's work list.

Common – Venkata Harish Kajur working on

Router-core – AMDOCs to work

Update 16 March: James Forsyth to verify on PTL call if all vulnerabilities 4 or above need to be cleared in order to pass.

Update 21 March: Title of project must have ONAP as the first word; Mark Tooski to pickup Tian Lee's action items while he is out.

Update 4 April: We are at 97%

Update 13 June: CII Badging level for Casablanca to move from Passing to Silver

Image RemovedAAI-494 - Improve API Swagger Documentation IN PROGRESS

  •  Action items
  •  James Forsyth - Investigate CSIT jobs for validating services.
  •  James Forsyth and Venkata Harish Kajur - Look at automated PoC polling script, add test coverage.
  •  James Forsyth will reach out to Victor and Shankar on access to A&AI lab
  •  James Forsyth to document on Using AAI in OpenLab - "In Reply - post your verification was successful and working"
  •  Venkata Harish Kajur to create US to document the datagrooming steps/parameters for Beijing.
  •  Manisha Aggarwal - Look at use case for using Cacher in ONAP
  •  Former user (Deleted) - Look at integrating services with AAF using Cady
  •  Former user (Deleted) - Evaluate Kubernetes Ingress Controller as replacement for HAProxy and report next week
  •  Manisha Aggarwal - Advise next week if code coverage of 70% will be issue with Graph Admin (GA)
  •  Tian Lee - Advise next week if code coverage of 70% will be issue for new mS such as Champ
  •  Tian Lee - Tell Colin Burns of CII Badging requirement

...