README
¶
OpenAPI
A set of packages and tools for working with OpenAPI Specification documents.
Used directly in Speakeasy's product to power our SDK Generator and Contract Testing tools.
Main Packages
arazzo
The arazzo package provides an API for working with Arazzo documents including reading, creating, mutating, walking and validating them.
Sub Packages
This repository also contains a number of sub packages that are used by the main packages to provide the required functionality. The below packages may be moved into their own repository in the future, depending on future needs.
json
The json package provides utilities for converting between JSON and YAML.
jsonpointer
The jsonpointer package provides an API for working with RFC 6901 compliant JSON Pointers. Providing functionality for validating JSON Pointers, and extracting the target of a JSON Pointer for various Go types and structures.
jsonschema
The jsonschema package provides various models for working with the different JSON Schema dialects.
sequencedmap
The sequencedmap package provides a map implementation that maintains the order of keys as they are added.
Contributing
This repository is maintained by Speakeasy, but we welcome and encourage contributions from the community to help improve its capabilities and stability.
How to Contribute
-
Open Issues: Found a bug or have a feature suggestion? Open an issue to describe what you'd like to see changed.
-
Pull Requests: We welcome pull requests! If you'd like to contribute code:
- Fork the repository
- Create a new branch for your feature/fix
- Submit a PR with a clear description of the changes and any related issues
-
Feedback: Share your experience using the packages or suggest improvements.
All contributions, whether they're bug reports, feature requests, or code changes, help make this project better for everyone.
Please ensure your contributions adhere to our coding standards and include appropriate tests where applicable.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package arazzo provides an API for working with Arazzo documents including reading, creating, mutating, walking and validating them.
|
Package arazzo provides an API for working with Arazzo documents including reading, creating, mutating, walking and validating them. |
|
internal
|
|
|
Package json provides utilities for working with JSON.
|
Package json provides utilities for working with JSON. |
|
Package jsonpointer provides JSONPointer an implementation of RFC6901 https://datatracker.ietf.org/doc/html/rfc6901
|
Package jsonpointer provides JSONPointer an implementation of RFC6901 https://datatracker.ietf.org/doc/html/rfc6901 |
|
jsonschema
|
|
|
oas31
Package oas31 contains an implementation of the OAS v3.1 JSON Schema specification https://spec.openapis.org/oas/v3.1.0#schema-object
|
Package oas31 contains an implementation of the OAS v3.1 JSON Schema specification https://spec.openapis.org/oas/v3.1.0#schema-object |
|
Package pointer provides utilities for working with pointers.
|
Package pointer provides utilities for working with pointers. |
|
Package sequencedmap provides a map implementation that maintains the order of keys as they are added.
|
Package sequencedmap provides a map implementation that maintains the order of keys as they are added. |