oai / community Goto Github PK

View Code? Open in Web Editor NEW

8.0 8.0 8.0 42 KB

community's People

Contributors

Stargazers

Watchers

Forkers

namdeirf frankkilcommins jcasman dret priyansh121096 seanpm2001 sensiblewood

community's Issues

Contact Details

@namdeirf

Give your SIG a unique name, a one or two word descriptor.

This is a test of the SIG creation process, this is only a test

Give an overview of your SIG.

We want to test the 'if you build it, they will come' mindset.

Statement of Work

The goal is to build a baseball field in Iowa.

SIG Class

Industry SIG

History

A new group

How often do you intend to need to meet

Every other week

Teleconference link

Slack

discord

Code of Conduct

I agree to follow this project's Code of Conduct

Please make this a pinned repo in the OAI github org

Help us, @webron , you're our only hope! (or so @darrelmiller tells us... we need someone with admin rights :-)

triage & maintainers need permissions to transfer issues across repos

@webron I'm guessing we need your admin powers on this as well as I'm not sure anyone else has access to all the repos needed.

In today's call we agreed to remove some issue labels from the spec repo, but this requires @OAI/triage and @OAI/openapi-maintainers being able to transfer some of the labeled issues to other repos, specifically:

community (this repo)
learn.openapis.org
Outreach
Tooling
oascomply
Overlay-Specification
sig-*

Could this ability be added for both of those groups (at the moment, I don't think adding to triage automatically empowers maintainers).

Looking for a community driven GH home for unofficial OpenAPI projects

Discussed in OAI/OpenAPI-Specification#2504

^{Originally posted by @displague March 18, 2021; migrating to community repo as it is not a spec topic.}

I'm looking for a home for an OpenAPI project that has many users, stars, and GH forks but has not seen active maintainership recently and has no system of governance.

While the OAS spec advances, many tools that users have come to depend on are left in less than ideal states. There may be competing interests for each of these projects to adapt to the latest standards or continue to support their implementation discrepancies. The user and developer community behind these projects should have some say in this and largely do. Each of these projects takes on or shirks responsibility whenever OAS changes are introduced. A common body of similarly concerned projects could benefit from each other based on similar languages, users, developers, or ideas.

It is understandable that the OAI organization does not want to show favoritism to any single implementation and should want to avoid the situation where an implementation discrepancy with the spec becomes authoritative.

Many of the OAS tools available today are associated with commercial organizations:

https://github.com/swagger-api (SmartBear)
https://github.com/mermade

Are these or similar organizations open to adopting existing projects? Would they be able to provide a fair community view that fosters project independence, growth, and health?

Some community-run GH orgs actively maintain community projects or registries:

These orgs may not be open to adopting competing projects or engineering heavy projects.

1. Does @OAI have recommendations for projects looking for community governance and maintainership?

2. Does @OAI have recommendations for community-led initiatives to provide this function?

Authors that have expressed interest in having their tools moved to a central org:

Orgs that have expressed interest in hosting disparate projects and hosting community and governance:

https://github.com/openapi (@sergeysova)

is any tools with implements the validation the openApi by the Java annotation, such as io.swagger.v3.oas.annotations.media.Schema

[Request to Create SIG]: SIG for the Elearning industry

Contact Details

@Bellangelo

Give your SIG a unique name, a one or two word descriptor.

LMSHarmony, bring harmony among Learning Management Systems and their tools.

Give an overview of your SIG.

LMSHarmony is designed to be a comprehensive and enhanced specification for Learning Management Systems (LMS). This API aims to streamline and standardize the integration of various eLearning tools, platforms, and content providers, ensuring seamless interaction and interoperability across different educational technologies. LMSHarmony will focus on solving common problems faced by the eLearning industry, including integration challenges, data interoperability, user management and content delivery.

Statement of Work

Introduction

The LMSHarmony Special Interest Group (SIG) aims to develop, standardize, and promote a comprehensive OpenAPI specification tailored for the eLearning industry, focusing on Learning Management Systems (LMS). This new specification, LMSHarmony, will enhance and extend the functionalities of existing standards like Learning Tools Interoperability (LTI), addressing current challenges and future needs in the eLearning ecosystem.

Objectives

The primary objectives of the LMSHarmony SIG are:

Develop LMSHarmony: Create a robust, scalable, and flexible API specification that addresses the core needs of the eLearning industry.
Standardize Integration: Establish standardized protocols and data models to ensure seamless interoperability between different LMS platforms and third-party tools.
Enhance User Management: Provide comprehensive solutions for user authentication, authorization, and profile management.
Optimize Content Delivery: Support efficient and versatile content delivery mechanisms compatible with various formats and devices.
Promote Adoption: Advocate for the adoption of LMSHarmonyAPI across educational institutions, LMS providers, and eLearning tool developers.

Scope of Work

The LMSHarmony SIG will undertake the following activities to achieve its objectives:

Research and Analysis

Conduct a thorough analysis of existing eLearning standards, including LTI, SCORM, and xAPI.
Identify gaps, limitations, and areas for improvement in current specifications.
Gather input from stakeholders, including educators, LMS providers, and developers.
API Specification Development

Define the core entities and data models, such as User, Course, Content, Enrollment, Assignment and Grade.
Develop endpoints and protocols for seamless integration and data exchange.
Ensure the specification supports modern authentication and authorization mechanisms (e.g., OAuth 2.0).
Documentation and Guidelines

Create comprehensive documentation detailing the API endpoints, data models, and usage examples.
Develop best practice guidelines for implementing LMSHarmony.
Provide sample code and SDKs for popular programming languages.
Pilot Implementation and Testing

Collaborate with select LMS providers and eLearning tool developers to implement pilot projects.
Test the API in real-world scenarios to identify and resolve issues.
Collect feedback to refine and enhance the specification.
Community Engagement and Support

Establish a community portal for stakeholders to collaborate, share experiences, and provide feedback.
Conduct webinars, workshops, and presentations to promote LMSHarmonyAPI.
Offer support and resources to help organizations adopt and implement the specification.
Governance and Maintenance

Form a governance structure to oversee the ongoing development and maintenance of LMSHarmony.
Establish a process for handling updates, bug fixes, and new feature requests.
Ensure the specification remains up-to-date with emerging technologies and industry trends.

Deliverables

The LMSHarmony SIG will deliver the following:

LMSHarmony Specification Document: A detailed document outlining the API endpoints, data models, protocols, and standards.
Developer Documentation: Comprehensive guides, best practices, and usage examples to assist developers in implementing the API.
Sample Code and SDKs: Example implementations and software development kits for various programming languages.
Pilot Project Reports: Findings and insights from pilot implementations, including case studies and feedback analysis.
Community Portal: An online platform for collaboration, support, and community engagement.
Governance Framework: A structured approach to manage the ongoing development and maintenance of the specification.