Skip to content

Commit

Permalink
Fix formatting, make URLs into links
Browse files Browse the repository at this point in the history
  • Loading branch information
lornajane committed Sep 19, 2024
1 parent 55e533e commit ef767d6
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
4 changes: 2 additions & 2 deletions blog-post.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ The updates also strayed into distinctly "meta" areas, so we've also got:

## Beyond the specification

In addition to the main specifications that you can always find at https://spec.openapis.org, there are a number of other resources that you may find helpful:
In addition to the main specifications that you can always find at [spec.openapis.org](https://spec.openapis.org), there are a number of other resources that you may find helpful:

- OpenAPI's documentation and examples is available at https://learn.openapis.org.
- OpenAPI's documentation and examples is available at [learn.openapis.org](https://learn.openapis.org).
This site holds all the examples used in the main OpenAPI specification, and much more additional information besides.
- A [non-authoritative JSON Schema representation of the OpenAPI specification](https://spec.openapis.org/#non-normative-json-schemas) is available.
This representation should not require changes between 3.1.0 and 3.1.1 since patch releases don't change the structure.
Expand Down
5 changes: 3 additions & 2 deletions release-notes-3.1.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

While the 3.1.1 release makes no changes to requirements of the OpenAPI 3.1.0 specification, it does introduce a number of notable improvements, including:
- Expands and clarifies a number of explanations, including several new appendices with supplementary details
- Focuses on technical specifics by moving examples and additional documentation now published at https://learn.openapis.org
- Declares that the HTML specifications at https://spec.openapis.org are now the authoritative versions (formerly it was the Markdown source on GitHub)
- Focuses on technical specifics by moving examples and additional documentation now published at [learn.openapis.org](https://learn.openapis.org)
- Declares that the HTML specifications at [spec.openapis.org](https://spec.openapis.org) are now the authoritative versions (formerly it was the Markdown source on GitHub)

OpenAPI Description writers should mark their OpenAPI Descriptions with the version of the OpenAPI specification they used to write their specification, updating where possible.

Expand Down Expand Up @@ -41,6 +41,7 @@ Added a note that a `security` array that is empty or missing does not indicate
Updated references to other standards where newer versions are available, and added more explanation for OpenIDConnect.

Added a "Security Concerns" section containing advice for implementers and users of OpenAPI.

## Request Data

Extensive refactoring of the parameters section
Expand Down

0 comments on commit ef767d6

Please sign in to comment.