Skip to content

Commit 9b99ffb

Browse files
authored
Update SIGs list, improve formatting and links (#3551)
1 parent 68d98c2 commit 9b99ffb

File tree

1 file changed

+55
-20
lines changed

1 file changed

+55
-20
lines changed

SPECIAL_INTEREST_GROUPS.md

Lines changed: 55 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,78 @@
1+
# OpenAPI Special Interest Groups (SIGs)
2+
3+
OpenAPI Special Interest Groups, or "SIGs", are the OpenAPI Initiative's way of focusing work in particular areas. SIGs may start with just a Slack channel to guage interest. SIGs with enough traction to produce work may have their own GitHub repositories and regular Zoom calls, and ultimately produce work that becomes part of, or a companion to, the OpenAPI Specification.
4+
15
## Codegen
2-
> code-gen vocabulary special interest (working) group
36

4-
* Slack channel: #sig-codegen
7+
Code Generation JSON Schema vocabulary special interest (working) group
8+
9+
* [Slack](https://communityinviter.com/apps/open-api/openapi) channel: #sig-codegen
10+
11+
## Finance
12+
13+
Focusing on finance topics such as Open Banking / Open Finance
14+
15+
* [Slack](https://communityinviter.com/apps/open-api/openapi) channel: #sig-finance
516

617
## Formats
7-
> Focusing on the Formats Registry efforts
818

9-
* Slack channel: #sig-formats
19+
Focusing on the [Formats Registry](https://spec.openapis.org/registry/format/) efforts.
20+
21+
* [Slack](https://communityinviter.com/apps/open-api/openapi) channel: #sig-formats
22+
* Work Items: [Open Issues](https://github.com/OAI/OpenAPI-Specification/issues?q=is%3Aissue+is%3Aopen+label%3Aformat-registry), [Open PRs](https://github.com/OAI/OpenAPI-Specification/pulls?q=is%3Apr+is%3Aopen+label%3Aformat-registry)
23+
24+
## Inudstry Standards
25+
26+
Focusing on how industry standards groups make use of OpenAPI specifications.
27+
28+
* [Slack](https://communityinviter.com/apps/open-api/openapi) channel: #sig-industry-standards
1029

1130
## Lifecycle
12-
> A place to discuss how to represent how APIs change in time in the context of OpenAPI
1331

14-
* Slack channel: #sig-lifecycle
32+
A place to discuss how to represent how APIs change in time in the context of OpenAPI.
33+
34+
* [Slack](https://communityinviter.com/apps/open-api/openapi) channel: #sig-lifecycle
35+
36+
## Moonwalk
37+
38+
Working group for the next major (post-3.x) version of the OpenAPI Specification
39+
40+
* GitHub: [OAI/sig-moonwalk](https://github.com/OAI/sig-moonwalk)
41+
* Zoom Meetings: Tuesdays at 9AM US-Pacific
1542

1643
## Overlays
17-
> The Overlay specification defines a way of creating documents that contain information to be merged with an OpenAPI description at some later point in time, for the purpose of updating the OpenAPI description with additional information.
1844

19-
* Github: https://github.com/OAI/Overlay-Specification
20-
* Slack channel: #sig-overlays
45+
The Overlay specification defines a way of creating documents that contain information to be merged with an OpenAPI description at some later point in time, for the purpose of updating the OpenAPI description with additional information.
46+
47+
* GitHub: [OAI/Overlay-Specification](https://github.com/OAI/Overlay-Specification)
48+
* [Slack](https://communityinviter.com/apps/open-api/openapi) channel: #sig-overlays
2149

2250
## Security
23-
> Workgroup to shape security components of the OpenAPI Spec
24-
* Slack channel: #sig-security
51+
52+
Workgroup to shape security components of the OpenAPI Specification.
53+
54+
* [Slack](https://communityinviter.com/apps/open-api/openapi) channel: #sig-security
2555

2656
## SLA (Service Level Agreement)
27-
> Service level agreements and APIs.
2857

29-
* Github: https://github.com/isa-group/SLA4OAI-TC
30-
* Slack channel: #sig-sla
58+
Service level agreements and APIs.
59+
60+
* GitHub: [isa-group/SLA4OAI-TC](https://github.com/isa-group/SLA4OAI-TC)
61+
* [Slack](https://communityinviter.com/apps/open-api/openapi) channel: #sig-sla
3162

3263
## Travel
33-
> An OpenAPI Initiative workgroup to address industry specific connective/API concerns of the travel industry
3464

35-
* Slack channel: #sig-travel
65+
An OpenAPI Initiative workgroup to address industry specific connective/API concerns of the travel industry.
66+
67+
* [Slack](https://communityinviter.com/apps/open-api/openapi) channel: #sig-travel
3668

3769
## Workflows
38-
> This is a channel dedicated to discussing workflows, automations, and scenarios.
3970

40-
> The OpenAPI Specification provides a way to document individual API calls and how to use them, but it doesn't give insight into the common ways to sequence those operations. While all APIs can benefit from formally describing these workflows, this is particularly important when considering more complex or more secure APIs.
41-
> The OpenAPI Workflows Special Interest Group was created to address this common problem. The goal is to construct a formal way to describe these sequences and support documentation of flows, such as a multi-part OAuth flow with JSON signing and refresh token behavior.
71+
The OpenAPI Specification provides a way to document individual API calls and how to use them, but it doesn't give insight into the common ways to sequence those operations. While all APIs can benefit from formally describing these workflows, this is particularly important when considering more complex or more secure APIs.
72+
73+
The OpenAPI Workflows Special Interest Group was created to address this common problem. The goal is to construct a formal way to describe these sequences and support documentation of flows, such as a multi-part OAuth flow with JSON signing and refresh token behavior.
74+
75+
* GitHub: [OAI/sig-workflows](https://github.com/OAI/sig-workflows)
76+
* [Slack](https://communityinviter.com/apps/open-api/openapi) channel: #sig-workflows
77+
* Zoom Meetings: Wednesdays at 9AM US-Pacific
4278

43-
* Slack channel: #sig-workflows

0 commit comments

Comments
 (0)