Public Page

2021-04-27 Architecture Meeting Minutes

Owned by Paulette Reed
Last updated: May 11, 2021
4 min read

Public Page

 

      
   CIECA 500 Westover Dr  #11617; Sanford,  NC  27330 

 

Date

Apr 27, 2021

ANTITRUST STATEMENT

As participants in this meeting, we need to be mindful of the constraints of antitrust laws. There shall be no discussions of agreements or concerted actions that may restrain competition. This prohibition includes the exchange of information concerning individual prices, rates, coverages, market practices, claims settlement practices, or any other competitive aspect of an individual company’s operation. Each participant is obligated to speak up immediately for the purpose of preventing any discussion falling outside these bounds.

Agenda

  • Antitrust and Meeting minutes acceptance

  • Discuss OpenAPI 3.1 vs previous versions for CIECA APIs

  • Finalize and vote on SimpleTypes; we would like everyone to attend to make verify the guidelines being established

  • Review and vote on Style Guide

  • Versioning of CIECA API

Meeting Minutes

  • Antitrust Accepted

  • Meeting Minutes Accepted

  • The previous meeting there was discussion about what version of OpenAPI to use, since the new version(3.1) had formats available for some of the data we would be using. There was a link for everyone to review during the week so we could discuss the options.

    • The OpenAPI Spec and the JSON 2020-12 collaborated and are in sync, but tools are not updated at this time to support development.

  • It was recommended that we have a table or section in the meeting notes to clearly identify the Pros and Cons of the OpenAPI and what is discussed. The below table was worked on during the meeting.

 

Overview Versioning (OpenAPI 3.0 vs OpenAPI 3.1)

OpenAPI 3.0

OpenAPI 3.1

Version of JSON schema is draft-04 (extended subset)

Version of JSON schema is 2020-12 (which is backward compatible)

Extended subset

First synchronized version of JSON Schema and OpenAPI

Tools Support (for example: SwaggerHub, Apigee)

Not Much for Tool Support

2020-12

Integrations with most customers

Integrations may be limited based on tools

 

New Formats available, but if customers can not integrate, we will have to modify to be compatible to previous versions.

  1. It was decided to move forward with OpenAPI 3.1 and JSON 2020-12

  • XML Spy is working on incorporating the new version with the new release.

  • JSON is still trying to figure out to branch out on its own or just be part of OpenAPI.

    • Everyone will have to move to the new version of OpenAPI.

  • More details on the decision above, is we know it will take months to implement CIECA’s OpenAPI standards and by this time, we could have the tools to support the newest version.

  • GitHub currently has a validation built in for JSON and we can modify Jasmine to validate what we need validated.

  • Validation in JSON is different than XML

    • XML load rood schema and Validate

    • JSON you have to tell it what section you want to validate.

  1. At this time, we do not plan to use SwaggerHub because it does not support the version of JSON we will be developing.

  • Recommended to go back to the Free Trial of SwaggerHub until the tool is beneficial to the development.

  • YAML is a superset of JSON and is preferred in the industry.

  • What is needed for First Full Cycle:

Items to be completed:

Test Harness

OpenAPI Specification

Security

Definitions of Simple Types and Common Types

  • After Draft messages of FNOL; we will work with the FNOL Committee to confirm the messages and validate.

GitHub

  • Under the Projectcieca/cieca_api_standard there is a new branch for schema-changes-and-structure that has Mike Hastings documentation that he has been working on.

  • It was discussed that the capisSimpleTypesSchema.json was one way to implement the simple Types and reusable formats or there is the newer version of capisCommonPropertyTyepsSchema.json that can be used.

    • Things to consider, how many times will we use String, Max Length of 50?

      • If we change Max Length of 50, do we have to do analysis and change everything that uses Max Length 50 instead of just changing it in one place.

    • Can we not use Type: String?

  • Mike is going to change these to reflect the newer version that we decided to use in this meeting, this will allow everyone to see the concepts and we will decide what is best in the next meeting

Great Meeting Everyone! A number of members are not able to make next weeks meeting, so it will be cancelled. This gives Mike and extra week to work on the documentation in GitHub.

Up Next

  • Antitrust and Meeting minutes acceptance

  • Finalize and vote on SimpleTypes; we would like everyone to attend to make verify the guidelines being established

  • Review and vote on Style Guide

  • Versioning of CIECA API

 

 

Participants

  • Paulette Reed (Scribe)

  • Mike Hastings

  • Paul Barry

  • Cindy Chapman

  • Andy Bober

  • Aaron Daniele

  • Phil Martinez

  • Brad Broerman

  • Dan Webster

  • Jeff Schroder

 

Participants in the meetings are noted for your information.  If you have questions on the committee’s activities, please contact a recent attendee. Architecture Committee