Skip to content

Commit 40a957f

Browse files
committed
Refer to Arazzo spec
1 parent b71cc9f commit 40a957f

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
1-
# OpenAPI Workflow Parser
1+
# OpenAPI Workflow (Arazzo) Parser
22

33
[![](https://badgen.net/github/license/API-Flows/openapi-workflow-parser)](LICENSE)
44
[![](https://badgen.net/maven/v/maven-central/com.api-flows/openapi-workflow-parser)](https://repo1.maven.org/maven2/com/api-flows/openapi-workflow-parser/)
55
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=API-Flows_openapi-workflow-parser&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=API-Flows_openapi-workflow-parser)
66

7-
Parsing OpenAPI workflows.
7+
Parsing API workflows.
88

99
## Overview
1010

11-
The OpenAPI Workflow parser is an open-source Java library designed to parse the [OpenAPI SIG-Workflows specification](https://github.com/OAI/sig-workflows) files. It reads an OpenAPI workflow file (JSON or YAML formats are supported) and creates the corresponding Java objects.
11+
The OpenAPI Workflow parser is an open-source Java library designed to parse the [OAI Arazzo specification](https://https://github.com/OAI/Arazzo-Specification/) files. It reads an Arazzo file (JSON or YAML formats are supported) and creates the corresponding Java objects.
1212

13-
The parser's goal is to simplify the extraction and manipulation of OpenAPI workflows, helping developers create applications and tools that harness the semantic structure of API flows.
13+
The parser's goal is to simplify the extraction and manipulation of workflows, helping developers create applications and tools that harness the semantic structure of API flows.
1414

1515
## Features
1616

17-
- **Workflow Parsing:** Reads OpenAPI specification files loading the corresponding Java objects.
18-
- **Ease of Use:** Provides a simple way for developers to parse OpenAPI workflows.
19-
- **Compatibility:** Supports OpenAPI specifications in JSON and YAML formats.
20-
- **Validation:** Validates the OpenAPI specification according to the [Workflows Specification v1.0.0](https://github.com/OAI/sig-workflows/blob/main/versions/1.0.0.md).
17+
- **Workflow Parsing:** Reads OAI Arazzo specification files loading the corresponding Java objects.
18+
- **Ease of Use:** Provides a simple way for developers to parse workflows.
19+
- **Compatibility:** Supports both JSON and YAML formats.
20+
- **Validation:** Validates the specification according to the [Arazzo Specification v1.0.0](https://https://github.com/OAI/Arazzo-Specification/).
2121

2222
## Usage
2323

0 commit comments

Comments
 (0)