Versions Compared

Key

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

...

  1. Goals:

    1. Surface any fundamental issues
  2. Sprint logistics / scheduling

    1. Daily stand-up report in Slack - #dynamic-api-sprint-may-2022 channel
    2. A bi-daily meeting (Monday, Wednesday, Friday) at 10am Eastern Time (4pm CEST)
  3. Tools and resources 
    1. Branches
    2. Test datasets
    3. Integration tests
    4. Development processes
      1. Git / GitHub processes
      2. GitHub issues process
    5. Dev environment... please take as first task to establish this
  4. Tickets - https://github.com/orgs/vivo-project/projects/2/views/1

  5. Documentation - VIVO Dynamic API

  6. Tracks
    1. Ontology
      1. RDF representation of dynamic actions and resourceAPIs
    2. Binding
      1. Binding to Java objects representation 
    3. Execution
      1. Execution of a dynamic action
    4. RCP Endpoint
    5. REST Endpoint
    6. Security
      1. Definition of dynamic action roles
      2. Authentication (endpoint and UI)
      3. Authorization
        1. JWT
        2. Do we need OAuth2 or OpenID Connect ???
    7. Validation
      1. syntax,
      2. over the ontology,
      3. generic SHACL rules for all dynamic actions
      4. custom SHACL rules for specific dynamic actions ???
    8. UI for running a dynamic action
      1. Angular & Angular Material
      2. Some notes regarding angular from William Welling .

        1. I would recommend against using a openapi specification generator
               
            1. it likely does not take into consideration angular universal for SEO, central state management, or i18n
          1.    
            1. it is not likely to be a long lived dependency, popular, or actually work well with the dynamism of custom actions
          2. choose between the server side module (both express and angular universal)
            1. https://angular.io/guide/universal
            2. https://github.com/nestjs/ng-universal
          3. consider a central state management up front
            1. https://ngrx.io/
          4. choose i18n library (important to know whether we want runtime or build time i18n)
            1. http://www.ngx-translate.com/
            2. https://ngneat.github.io/transloco/
            3. https://angular.io/guide/i18n-overview
          5. adopt a style guide and have it enforced using linting
            1. have github action check code styles
            2. protect main branch against style guide violations
          6. incorporate best practices and have test coverage in initial commit
            1. have github action that performs code coverage
            2. protect main branch for code coverage decrease
      3. CRUD operations for custom actions
      4. UI for management of custom actions
      5. Exploitation

    ...