OAI / Projects

All of the open projects occurring within the Open API Initiative (OAI) community.
Apache License 2.0
15 stars 9 forks source link

OAI Special Interest Group (SIG) Overview #12

Open kinlane opened 2 years ago

kinlane commented 2 years ago

Overview

This is an overview of the Special Interest Groups (SIG) that have been emerging within the OpenAPI Initiative (OAI), working to provide a simple overview of what SIGs are, how they operate, and how they can contribute to moving forward the conversation around the OpenAPI Specification (OAS). Providing an evolvable document that can help OAI members establish new SIGs, and evolve the conversation around the existing ones.

Types of SIGs

Currently, there are two types of SiGS that have emerged to move forward some aspect of using OAS, with the first one being about establishing and developing specific extensions to OAS, with some eventually becoming a formal part of the specification, or remaining as an extension or overlay to the spec.

The other type of SIG is more focused on the usage of OAS in service of a specific industry, which may eventually contribute changes, extensions, or overlays to OAS, but will be more likely about coordination across OAS usage withinn specific industry.

These are just the first wave of SIGs to be formalized in the last six months, with some of them existing in various forms before the door was opened in May of 2021 for groups to be formed using a less formal review process--encouraging the creation of SIGs with as little friction and allowing them to grow organically over time-based upon activity defined by each group.

SIG Building Blocks

These are some of the commonly recommended building blocks to help move each SIG forward in a standardized way, helping provide a common blueprint that SiGs can employ to move forward each conversation and encourage participation within the OAS community.

That represents what is currently in use to manage SIGs. None of these are required but should provide a set of common practices to consider. If there are other things like calendar, document management, and other building blocks in use, please let us know so that we can add to this list and inform each of the existing SIGS, as well as new ones.

Relationship to Other Existing OAI Groups

SIGs are intended to operate independently of the Technical Steering Committee (TSC), marketing group, and ASC steering committee, moving forward at their own speed, providing regular sync with existing groups, and following the process that is already established.

Designated SIG leadership are encouraged to bring short updates to existing group gatherings as required but should follow existing group rules and processes when it comes to making contributions or requesting attention or resources from a group.

OAI SIG Structure and Process

It was decided in May of 2021 to go with a less formal approach to starting up and operating SIGs to encourage their formation and evolution. The OAI depends on each group champion and leader to define and manage each SIG and contribute to existing OAI projects, groups, and discussions. There is no formal OAI structure or process for how SIGs should operate, with this document being just one attempt at documenting what is currently happening. Neal has created a pull request in the main specification repository for gathering SIG titles, descriptions, and other information. This issue, as well as the supporting the Kanban board is just working to try to continue formalizing and communicating the structure and process for SIGs but does not claim to be the formal process, or is comprehensive--it is just an attempt to capture what is happening in motion.

Like most aspects of the OAI, SIGs are dependent on champions to move things forward and help define what SIGs are and how they add value to OAS and the community. Please share your feedback, corrections, additions, and concerns below, and feel free to add to the project Kanban board, update your SIG's information, or start up a new SIG to move forward with something that matters to you. SIGs reflect a pretty compelling opportunity to move OAS and the OAI community forward in different ways, beyond the core specification development, and marketing activities that have been going on since the forming of the OAI. We look forward to what your SIG can do, and encourage your participation in helping push forward the SIG discussion within the OAI and OAS community.

swaldron58 commented 2 years ago

Great work! Suggestion and a request for sig-travel I added a project board connected to each issue. https://github.com/OAI/sig-travel/projects/1 Trying to get more task orientated to keep things moving. my request is to have a common calendar for the sigs. Nothing fancy, just somewhere to see at a glance when the various sigs normally meet. Less important, a common tool for video conferences. @kinlane, pick anyone you favor but along with a common calendar, list how to get on the call in a more repeatable and predictable way.

kinlane commented 2 years ago

Some notes from latest SIG planning meeting:

Nick - Workflows

Ron - Overlays & Formats

Overall