Skip to content

Commit 33ca6a5

Browse files
simplesagarchailandauTristanSpeakEasy
authored
chore: update readme links and badges (#31)
Co-authored-by: Chai Landau <[email protected]> Co-authored-by: Tristan Cartledge <[email protected]> Co-authored-by: Tristan Cartledge <[email protected]>
1 parent 80ba26e commit 33ca6a5

File tree

5 files changed

+19
-13
lines changed

5 files changed

+19
-13
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@
1818
<img width="200px" alt="OpenAPI" src="https://github.com/user-attachments/assets/555a0899-5719-42ee-b4b1-ece8d1d812ea">
1919
</p>
2020
<h1 align="center"><b>OpenAPI</b></h1>
21-
<p align="center">A set of packages and tools for working with <a href="https://www.speakeasy.com/openapi">OpenAPI Specification documents</a>. <br /> Used directly in Speakeasy's product to power our <a href="https://www.speakeasy.com/docs/create-client-sdks">SDK Generator</a> and <a href="https://www.speakeasy.com/docs/testing">Contract Testing</a> tools.
21+
<p align="center">A set of packages and tools for working with <a href="https://www.speakeasy.com/openapi">OpenAPI Specification documents</a>. <br /> Used directly in Speakeasy's product to power our <a href="https://www.speakeasy.com/product/sdk-generation">SDK Generation</a> and <a href="https://www.speakeasy.com/product/gram">Gram</a> products.
2222

2323
</p>
2424
<p align="center">
2525
<!-- Badges -->
2626
<!-- OpenAPI Hub Badge -->
27-
<a href="https://www.speakeasy.com/openapi"><img src="https://custom-icon-badges.demolab.com/badge/-OpenAPI%20Hub-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
27+
<a href="https://www.speakeasy.com/openapi"><img alt="OpenAPI Hub" src="https://www.speakeasy.com/assets/badges/openapi-hub.svg" /></a>
2828
<!-- OpenAPI Support Badge -->
2929
<a href="https://www.speakeasy.com/openapi"><img alt="OpenAPI Support" src="https://img.shields.io/badge/OpenAPI-3.0%20%7C%203.1-85EA2D.svg?style=for-the-badge&logo=openapiinitiative"></a>
3030
<!-- Arazzo Support Badge -->
@@ -53,9 +53,9 @@
5353
<img alt="Go Install" src="https://img.shields.io/badge/go%20install-ready-00ADD8.svg?style=for-the-badge&logo=go">
5454
<!-- Line Break --><br/>
5555
<!-- Built By Speakeasy Badge -->
56-
<a href="https://speakeasy.com/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
56+
<a href="https://speakeasy.com/"><img alt="Built by Speakeasy" src="https://www.speakeasy.com/assets/badges/built-by-speakeasy.svg" /></a>
5757
<!-- License Badge -->
58-
<a href="/LICENSE"><img alt="Software License" src="https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge"></a>
58+
<a href="/LICENSE"><img alt="Software License" src="https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge"></a>
5959
</p>
6060
</p>
6161

@@ -155,4 +155,3 @@ This repository is maintained by Speakeasy, but we welcome and encourage contrib
155155
All contributions, whether they're bug reports, feature requests, or code changes, help make this project better for everyone.
156156

157157
Please ensure your contributions adhere to our coding standards and include appropriate tests where applicable.
158-

arazzo/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@
66
<p align="center">An API for working with <a href="https://www.speakeasy.com/openapi/arazzo">Arazzo documents</a> including: read, walk, create, mutate, and validate
77
</p>
88
<p align="center">
9-
<a href="https://www.speakeasy.com/openapi/arazzo"><img src="https://custom-icon-badges.demolab.com/badge/-Arazzo%20Reference-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
10-
<a href="https://speakeasy.com/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
9+
<!-- Arazzo Reference badge -->
10+
<a href="https://www.speakeasy.com/openapi/arazzo"><img alt="Arazzo reference" src="https://www.speakeasy.com/assets/badges/arazzo-reference.svg" /></a>
11+
<!-- Built By Speakeasy Badge -->
12+
<a href="https://speakeasy.com/"><img alt="Built by Speakeasy" src="https://www.speakeasy.com/assets/badges/built-by-speakeasy.svg" /></a>
1113
<a href="https://github.com/speakeasy-api/openapi/releases/latest"><img alt="Release" src="https://img.shields.io/github/release/speakeasy-api/openapi.svg?style=for-the-badge"></a>
1214
<a href="https://pkg.go.dev/github.com/speakeasy-api/openapi/arazzo?tab=doc"><img alt="Go Doc" src="https://img.shields.io/badge/godoc-reference-blue.svg?style=for-the-badge"></a>
1315
<br />

openapi/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@
66
<p align="center">An API for working with <a href="https://spec.openapis.org/oas/v3.1.1">OpenAPI documents</a> including: read, walk, create, mutate, validate, and upgrade
77
</p>
88
<p align="center">
9-
<a href="https://www.speakeasy.com/openapi"><img src="https://custom-icon-badges.demolab.com/badge/-OpenAPI%20Reference-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
10-
<a href="https://speakeasy.com/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
9+
<!-- OpenAPI Hub Badge -->
10+
<a href="https://www.speakeasy.com/openapi"><img alt="OpenAPI Hub" src="https://www.speakeasy.com/assets/badges/openapi-hub.svg" /></a>
11+
<!-- Built By Speakeasy Badge -->
12+
<a href="https://speakeasy.com/"><img alt="Built by Speakeasy" src="https://www.speakeasy.com/assets/badges/built-by-speakeasy.svg" /></a>
1113
<a href="https://github.com/speakeasy-api/openapi/releases/latest"><img alt="Release" src="https://img.shields.io/github/release/speakeasy-api/openapi.svg?style=for-the-badge"></a>
1214
<a href="https://pkg.go.dev/github.com/speakeasy-api/openapi/openapi?tab=doc"><img alt="Go Doc" src="https://img.shields.io/badge/godoc-reference-blue.svg?style=for-the-badge"></a>
1315
<br />
@@ -618,7 +620,7 @@ if err := openapi.Marshal(ctx, doc, buf); err != nil {
618620
fmt.Printf("Document with components:\n%s", buf.String())
619621
```
620622

621-
## Inline all references in a JSON Schema,
623+
## Inline all references in a JSON Schema
622624

623625
creating a self-contained schema that doesn't depend on external definitions.
624626

@@ -773,4 +775,4 @@ This repository is maintained by Speakeasy, but we welcome and encourage contrib
773775

774776
All contributions, whether they're bug reports, feature requests, or code changes, help make this project better for everyone.
775777

776-
Please ensure your contributions adhere to our coding standards and include appropriate tests where applicable.
778+
Please ensure your contributions adhere to our coding standards and include appropriate tests where applicable.

openapi/openapi_examples_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -738,7 +738,7 @@ func Example_workingWithComponents() {
738738
// type: integer
739739
}
740740

741-
// Example_inliningSchema demonstrates how to inline all references in a JSON Schema,
741+
// Example_inliningSchema demonstrates how to inline all references in a JSON Schema
742742
// creating a self-contained schema that doesn't depend on external definitions.
743743
func Example_inliningSchema() {
744744
ctx := context.Background()

overlay/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@
66
<p align="center">An implementation of the <a href="https://github.com/OAI/Overlay-Specification/blob/3f398c6/versions/1.0.0.md">OpenAPI Overlay Specification</a> for applying modifications to OpenAPI documents
77
</p>
88
<p align="center">
9-
<a href="https://speakeasy.com/openapi/overlays"><img src="https://custom-icon-badges.demolab.com/badge/-Overlay%20Reference-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
9+
<!-- Overlay Reference badge -->
10+
<a href="https://speakeasy.com/openapi/overlays"><img alt="Overlay reference" src="https://www.speakeasy.com/assets/badges/overlay-reference.svg" /></a>
11+
<!-- Built By Speakeasy Badge -->
12+
<a href="https://speakeasy.com/"><img alt="Built by Speakeasy" src="https://www.speakeasy.com/assets/badges/built-by-speakeasy.svg" /></a>
1013
<a href="https://github.com/speakeasy-api/openapi/releases/latest"><img alt="Release" src="https://img.shields.io/github/release/speakeasy-api/openapi.svg?style=for-the-badge"></a>
1114
<a href="https://pkg.go.dev/github.com/speakeasy-api/openapi-overlay?tab=doc"><img alt="Go Doc" src="https://img.shields.io/badge/godoc-reference-blue.svg?style=for-the-badge"></a>
1215
<br />

0 commit comments

Comments
 (0)