This is a repo for moving forward a variety of projects within the OpenAPI community. In an effort to be more transparent and help involve the community in a variety of ways we will be managing most projects within this repository. This README should provide you with everything you need to get started working on an existing project, or suggest a new project.
We are just getting started with this effort to external project work, so this process will evolve. Here are the moving parts for managing projects using this repository:
- README - The README is the "home page" for all the project being managed and will be kept as an overview of everything that is happening.
- Issues - We are using issues for the catch all basket for any comments, questions, or feedback, and projects can have multiple issues.
- Projects - Once an idea or suggestion for a new project is set into motion it will be given a formal project for managing all tasks.
- Pages - Ongoing projects may also have a dedicated markdown page that provides access to any related documents and artifacts.
- Folder - Projects may also be able to have their own folders within the repository for organizing any code or related artifacts.
Feel free to suggest a new project by submitting an issue, or get involved in a specific project by jumping in on the issues or the discussions for each area of work.
These are the projects currently being moved forward in some capacity. Each project has a listing of to-do, in progress, and done tasks, as well as link to any open issues or discussions.
| Project | Description |
|---|---|
| Member Showcase & Engagement | Continually improving how we showcase and engage with the members of the OAI, and increase their participation within the OAS community. |
| Profile & Engage with API Providers | Work to identify, profile, and build relationships with API providers who have implemented the OpenAPI specification, and publish profile to a central database. |
| Profile and Engage with Open Source Tooling | Establish an official directory of open source tooling that uses OAS, and actively work to establish and build relationships with each tooling provider to get them more involved in the community. |
| Business Sector Showcase & Engagement | Work to profile business sectors that are putting OpenAPI to work, then engage, and build relationships with individuals or organizations, while helping stimulate OAI special interest groups in these areas. |
| Quantify the Scope of the OpenAPI Community | Work to establish the size and scope of the OpenAPI community and then track on the growth over time. |
| Strengthen Multi-Specification Relationships | Ongoing work to help strengthen the relationships between the OAI and other API specifications like AsyncAPI, GraphQL, JSON Schema, and gRPC. |
| Curate and Publish API Articles, Podcasts, Videos | Work to discover, curate, and then showcase and syndicate the existing articles, podcasts, and videos that exist about OpenAPI. |
| Additional OAI Leadership | Work to define the roles for 3 additional leadership within the OAI, and help them be successful in work over a year. |
| JSON Schema Documentation Update | This is work to invest in the updating of JSON Schema documentation, helping invest in supporting specifications. |
| OpenAPI Search Engine Optimization | This is ongoing work to help improve the search engine optimization for the OAI and OAS, helping increase it's presence. |
| Workflow SIG | This is a group to move forward the workflow and scenario conversation. |
| Security SIG | This is a group to move forward the security discussion. |
| SLA SIG | This is a group to move forward the SLA conversation. |
| Travel SIG | This is a group to move the travel conversation forward. |
| Overlays | This is to track on all the moving parts of the overlays conversation. |
| Healthcare SIG | This is a project to setup a working group to focus on the healthcare industry. |
| Pitch Deck | Move forward the work around a formal pitch deck to represent what OpenAPI is to individual onboarding with the spec or the OAI as an organization. |
| API Specifications Conference | Keep track of some of the goings on around ASC. |
| Office Hours | This is a project to offer ongoing weekly office hours where anyone can come and learn about the OAI, OAS, and how it all works. |
| SIG Planning | This is a project to track on the details across the SIGs. Each SIG has own project board, but this is used to plan across the SIGs. |
| New Member Identification & Engagement | Work to identify potential new members to the OAI and reach out to them to help start a conversation and make them aware of the benefits of being a member. |
| Business Governance Board (BGB) | This is used to manage tasks for the BGB, helping Neal, Isabel, and Kin be more organized. |
| Extension Directory | This is a project to move forward an official OAI extension registry, cataloging how the specification is being extended. |
| Blog Process | How do you submit a story for inclusion on the blog. |
| Project | Description |
|---|
As projects are complete they will be closed, with some projects living on forever and issues and discussions being used to drive ongoing work.
These are the individuals who are currently part of moving projects forward as part of the OAI, and here to answer any questions.
- Kin Lane - Representing as co-chair of the BGB Board.
- Chris Tsai - Identifying & engaging new members to grow the OAI.
- Chris Wood - Engaging with open source tooling and curate content.
- Phil Sturgeon - Engaging with APIs, open source tooling and curate content.
If you'd like to be added please submit a Github issue stating how you'd like to help and we'll add you to the list of participants.