Skip to content

Commit bf9eb29

Browse files
robjtederobjtede
committed
docs: HTML spec is now authoritative
1 parent bb40483 commit bf9eb29

25 files changed

+90
-90
lines changed

‎crates/oas3/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,6 @@ match oas3::from_path("path/to/openapi.yml") {
3030
}
3131
```
3232

33-
[OpenAPI v3.1]: https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md
33+
[OpenAPI v3.1]: https://spec.openapis.org/oas/v3.1.0
3434

3535
<!-- cargo-rdme end -->

‎crates/oas3/src/lib.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
//! }
1313
//! ```
1414
//!
15-
//! [OpenAPI v3.1]: https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md
15+
//! [OpenAPI v3.1]: https://spec.openapis.org/oas/v3.1.0
1616
1717
#![warn(missing_docs)]
1818
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
@@ -28,7 +28,7 @@ pub use self::{error::Error, spec::Spec};
2828
///
2929
/// Refer to the official [specification] for more information.
3030
///
31-
/// [specification]: https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md
31+
/// [specification]: https://spec.openapis.org/oas/v3.1.0
3232
pub type OpenApiV3Spec = spec::Spec;
3333

3434
/// Try deserializing an OpenAPI spec (YAML or JSON) from a file, giving the path.

‎crates/oas3/src/spec/components.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ use super::{
1212
/// All objects defined within the components object will have no effect on the API unless
1313
/// they are explicitly referenced from properties outside the components object.
1414
///
15-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#components-object>.
15+
/// See <https://spec.openapis.org/oas/v3.1.0#components-object>.
1616
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
1717
pub struct Components {
1818
/// An object to hold reusable [Schema Objects](ObjectSchema).
@@ -71,7 +71,7 @@ pub struct Components {
7171
///
7272
/// Only "x-" prefixed keys are collected, and the prefix is stripped.
7373
///
74-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#specification-extensions>.
74+
/// See <https://spec.openapis.org/oas/v3.1.0#specification-extensions>.
7575
#[serde(flatten, with = "spec_extensions")]
7676
pub extensions: BTreeMap<String, serde_json::Value>,
7777
}

‎crates/oas3/src/spec/contact.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ pub struct InvalidEmail;
1414

1515
/// Contact information for the exposed API.
1616
///
17-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#contact-object>.
17+
/// See <https://spec.openapis.org/oas/v3.1.0#contact-object>.
1818
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
1919
pub struct Contact {
2020
/// Identifying name of the contact person/organization.
@@ -36,7 +36,7 @@ pub struct Contact {
3636
///
3737
/// Only "x-" prefixed keys are collected, and the prefix is stripped.
3838
///
39-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#specification-extensions>.
39+
/// See <https://spec.openapis.org/oas/v3.1.0#specification-extensions>.
4040
#[serde(flatten, with = "spec_extensions")]
4141
pub extensions: BTreeMap<String, serde_json::Value>,
4242
}

‎crates/oas3/src/spec/discriminator.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! Schema specification for [OpenAPI 3.1](https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md)
1+
//! Schema specification for [OpenAPI 3.1](https://spec.openapis.org/oas/v3.1.0)
22
33
use std::collections::BTreeMap;
44

@@ -10,7 +10,7 @@ use serde::{Deserialize, Serialize};
1010
/// The discriminator is a specific object in a schema which is used to inform the consumer of the
1111
/// document of an alternative schema based on the value associated with it.
1212
///
13-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#discriminator-object>.
13+
/// See <https://spec.openapis.org/oas/v3.1.0#discriminator-object>.
1414
#[derive(Debug, Clone, PartialEq, Default, Deserialize, Serialize)]
1515
#[serde(rename_all = "camelCase")]
1616
pub struct Discriminator {

‎crates/oas3/src/spec/encoding.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ pub struct Encoding {
2525
pub headers: BTreeMap<String, ObjectOrReference<Header>>,
2626

2727
/// Describes how a specific property value will be serialized depending on its type.
28-
/// See [Parameter Object](https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#parameter-object)
28+
/// See [Parameter Object](https://spec.openapis.org/oas/v3.1.0#parameter-object)
2929
/// for details on the
30-
/// [`style`](https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#parameterStyle)
30+
/// [`style`](https://spec.openapis.org/oas/v3.1.0#parameterStyle)
3131
/// property. The behavior follows the same values as `query` parameters, including
3232
/// default values. This property SHALL be ignored if the request body media type
3333
/// is not `application/x-www-form-urlencoded`.
@@ -37,7 +37,7 @@ pub struct Encoding {
3737
/// When this is true, property values of type `array` or `object` generate
3838
/// separate parameters for each value of the array, or key-value-pair of the map.
3939
/// For other types of properties this property has no effect. When
40-
/// [`style`](https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#encodingStyle)
40+
/// [`style`](https://spec.openapis.org/oas/v3.1.0#encodingStyle)
4141
/// is `form`, the default value is `true`. For all other styles, the default value
4242
/// is `false`. This property SHALL be ignored if the request body media type is
4343
/// not `application/x-www-form-urlencoded`.

‎crates/oas3/src/spec/example.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ use super::{spec_extensions, FromRef, Ref, RefError, RefType, Spec};
88
///
99
/// Will be validated against schema when used in conformance testing.
1010
///
11-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#example-object>.
11+
/// See <https://spec.openapis.org/oas/v3.1.0#example-object>.
1212
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
1313
pub struct Example {
1414
/// Short description for the example.
@@ -38,7 +38,7 @@ pub struct Example {
3838
///
3939
/// Only "x-" prefixed keys are collected, and the prefix is stripped.
4040
///
41-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#specification-extensions>.
41+
/// See <https://spec.openapis.org/oas/v3.1.0#specification-extensions>.
4242
#[serde(flatten, with = "spec_extensions")]
4343
pub extensions: BTreeMap<String, serde_json::Value>,
4444
}

‎crates/oas3/src/spec/external_doc.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ use super::spec_extensions;
77

88
/// Allows referencing an external resource for extended documentation.
99
///
10-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#external-documentation-object>.
10+
/// See <https://spec.openapis.org/oas/v3.1.0#external-documentation-object>.
1111
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
1212
pub struct ExternalDoc {
1313
/// The URL for the target documentation.
@@ -22,7 +22,7 @@ pub struct ExternalDoc {
2222
///
2323
/// Only "x-" prefixed keys are collected, and the prefix is stripped.
2424
///
25-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#specification-extensions>.
25+
/// See <https://spec.openapis.org/oas/v3.1.0#specification-extensions>.
2626
#[serde(flatten, with = "spec_extensions")]
2727
pub extensions: BTreeMap<String, serde_json::Value>,
2828
}

‎crates/oas3/src/spec/flows.rs

+10-10
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ use super::spec_extensions;
77

88
/// Allows configuration of the supported OAuth Flows.
99
///
10-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#oauth-flows-object>.
10+
/// See <https://spec.openapis.org/oas/v3.1.0#oauth-flows-object>.
1111
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
1212
#[serde(rename_all = "camelCase")]
1313
pub struct Flows {
@@ -31,14 +31,14 @@ pub struct Flows {
3131
///
3232
/// Only "x-" prefixed keys are collected, and the prefix is stripped.
3333
///
34-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#specification-extensions>.
34+
/// See <https://spec.openapis.org/oas/v3.1.0#specification-extensions>.
3535
#[serde(flatten, with = "spec_extensions")]
3636
pub extensions: BTreeMap<String, serde_json::Value>,
3737
}
3838

3939
/// Configuration details for a implicit OAuth Flow.
4040
///
41-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#oauth-flow-object>.
41+
/// See <https://spec.openapis.org/oas/v3.1.0#oauth-flow-object>.
4242
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
4343
#[serde(rename_all = "camelCase")]
4444
pub struct ImplicitFlow {
@@ -63,14 +63,14 @@ pub struct ImplicitFlow {
6363
///
6464
/// Only "x-" prefixed keys are collected, and the prefix is stripped.
6565
///
66-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#specification-extensions>.
66+
/// See <https://spec.openapis.org/oas/v3.1.0#specification-extensions>.
6767
#[serde(flatten, with = "spec_extensions")]
6868
pub extensions: BTreeMap<String, serde_json::Value>,
6969
}
7070

7171
/// Configuration details for a password OAuth Flow.
7272
///
73-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#oauth-flow-object>.
73+
/// See <https://spec.openapis.org/oas/v3.1.0#oauth-flow-object>.
7474
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
7575
#[serde(rename_all = "camelCase")]
7676
pub struct PasswordFlow {
@@ -94,7 +94,7 @@ pub struct PasswordFlow {
9494

9595
/// Configuration details for a client credentials OAuth Flow.
9696
///
97-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#oauth-flow-object>.
97+
/// See <https://spec.openapis.org/oas/v3.1.0#oauth-flow-object>.
9898
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
9999
#[serde(rename_all = "camelCase")]
100100
pub struct ClientCredentialsFlow {
@@ -118,7 +118,7 @@ pub struct ClientCredentialsFlow {
118118

119119
/// Configuration details for a authorization code OAuth Flow.
120120
///
121-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#oauth-flow-object>.
121+
/// See <https://spec.openapis.org/oas/v3.1.0#oauth-flow-object>.
122122
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
123123
#[serde(rename_all = "camelCase")]
124124
pub struct AuthorizationCodeFlow {
@@ -153,16 +153,16 @@ pub struct AuthorizationCodeFlow {
153153
/// callback object is an expression, evaluated at runtime, that identifies a URL to use for the
154154
/// callback operation.
155155
///
156-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#callback-object>.
156+
/// See <https://spec.openapis.org/oas/v3.1.0#callback-object>.
157157
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Default)]
158158
pub struct Callback(
159159
/// A Path Item Object used to define a callback request and expected responses.
160-
serde_json::Value, // TODO: Add "Specification Extensions" https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#specificationExtensions}
160+
serde_json::Value, // TODO: Add "Specification Extensions" https://spec.openapis.org/oas/v3.1.0#specificationExtensions}
161161
);
162162

163163
// FIXME: Implement
164164
// /// Allows configuration of the supported OAuth Flows.
165-
// /// https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#oauthFlowsObject
165+
// /// https://spec.openapis.org/oas/v3.1.0#oauthFlowsObject
166166
// #[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Default)]
167167
// pub struct OAuthFlows {
168168
// }

‎crates/oas3/src/spec/header.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ use super::{
1515
/// 1. All traits that are affected by the location MUST be applicable to a location of
1616
/// `header` (for example, [`style`]).
1717
///
18-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#header-object>.
18+
/// See <https://spec.openapis.org/oas/v3.1.0#header-object>.
1919
///
20-
/// [Parameter Object]: https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#parameter-object
21-
/// [`style`]: https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#parameterStyle
20+
/// [Parameter Object]: https://spec.openapis.org/oas/v3.1.0#parameter-object
21+
/// [`style`]: https://spec.openapis.org/oas/v3.1.0#parameterStyle
2222
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Default)]
2323
pub struct Header {
2424
/// A brief description of the header.
@@ -103,7 +103,7 @@ pub struct Header {
103103
///
104104
/// Only "x-" prefixed keys are collected, and the prefix is stripped.
105105
///
106-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#specification-extensions>.
106+
/// See <https://spec.openapis.org/oas/v3.1.0#specification-extensions>.
107107
#[serde(flatten, with = "spec_extensions")]
108108
pub extensions: BTreeMap<String, serde_json::Value>,
109109
}

‎crates/oas3/src/spec/info.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ use super::{spec_extensions, Contact, License};
88
/// General information about the API.
99
///
1010
///
11-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#info-object>.
11+
/// See <https://spec.openapis.org/oas/v3.1.0#info-object>.
1212
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
1313
// #[serde(rename_all = "lowercase")]
1414
pub struct Info {
@@ -28,7 +28,7 @@ pub struct Info {
2828
pub terms_of_service: Option<Url>,
2929

3030
/// The version of the OpenAPI document (which is distinct from the [OpenAPI Specification
31-
/// version](https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#oasVersion)
31+
/// version](https://spec.openapis.org/oas/v3.1.0#oasVersion)
3232
/// or the API implementation version).
3333
pub version: String,
3434

@@ -44,7 +44,7 @@ pub struct Info {
4444
///
4545
/// Only "x-" prefixed keys are collected, and the prefix is stripped.
4646
///
47-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#specification-extensions>.
47+
/// See <https://spec.openapis.org/oas/v3.1.0#specification-extensions>.
4848
#[serde(flatten, with = "spec_extensions")]
4949
pub extensions: BTreeMap<String, serde_json::Value>,
5050
}

‎crates/oas3/src/spec/license.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ use super::spec_extensions;
77

88
/// License information for the exposed API.
99
///
10-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#license-object>.
10+
/// See <https://spec.openapis.org/oas/v3.1.0#license-object>.
1111
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
1212
pub struct License {
1313
/// The license name used for the API.
@@ -25,7 +25,7 @@ pub struct License {
2525
///
2626
/// Only "x-" prefixed keys are collected, and the prefix is stripped.
2727
///
28-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#specification-extensions>.
28+
/// See <https://spec.openapis.org/oas/v3.1.0#specification-extensions>.
2929
#[serde(flatten, with = "spec_extensions")]
3030
pub extensions: BTreeMap<String, serde_json::Value>,
3131
}

‎crates/oas3/src/spec/link.rs

+9-9
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ use super::{spec_extensions, Server};
1919
/// The `operationRef` and `operationId` fields are mutually exclusive and so this structure is
2020
/// modelled as an enum.
2121
///
22-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#link-object>.
22+
/// See <https://spec.openapis.org/oas/v3.1.0#link-object>.
2323
///
24-
/// [runtime expression]: https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#runtime-expressions
24+
/// [runtime expression]: https://spec.openapis.org/oas/v3.1.0#runtime-expressions
2525
#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
2626
#[serde(untagged)]
2727
pub enum Link {
@@ -33,7 +33,7 @@ pub enum Link {
3333
/// [Operation Object]. Relative `operationRef` values MAY be used to locate an existing
3434
/// [Operation Object] in the OpenAPI definition.
3535
///
36-
/// [Operation Object]: https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#operation-object
36+
/// [Operation Object]: https://spec.openapis.org/oas/v3.1.0#operation-object
3737
#[serde(rename = "operationRef")]
3838
operation_ref: String,
3939

@@ -44,7 +44,7 @@ pub enum Link {
4444
/// qualified using the [parameter location] `[{in}.]{name}` for operations that use the
4545
/// same parameter name in different locations (e.g. path.id).
4646
///
47-
/// [parameter location]: https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#parameterIn
47+
/// [parameter location]: https://spec.openapis.org/oas/v3.1.0#parameterIn
4848
//
4949
// FIXME: Implement
5050
// parameters: BTreeMap<String, Any | {expression}>,
@@ -54,7 +54,7 @@ pub enum Link {
5454

5555
// FIXME: Implement
5656
// /// A literal value or
57-
// /// [{expression}](https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#runtimeExpression)
57+
// /// [{expression}](https://spec.openapis.org/oas/v3.1.0#runtimeExpression)
5858
// /// to use as a request body when calling the target operation.
5959
// #[serde(rename = "requestBody")]
6060
// request_body: Any | {expression}
@@ -74,7 +74,7 @@ pub enum Link {
7474
///
7575
/// Only "x-" prefixed keys are collected, and the prefix is stripped.
7676
///
77-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#specification-extensions>.
77+
/// See <https://spec.openapis.org/oas/v3.1.0#specification-extensions>.
7878
#[serde(flatten, with = "spec_extensions")]
7979
extensions: BTreeMap<String, serde_json::Value>,
8080
},
@@ -93,7 +93,7 @@ pub enum Link {
9393
/// qualified using the [parameter location] `[{in}.]{name}` for operations that use the
9494
/// same parameter name in different locations (e.g. path.id).
9595
///
96-
/// [parameter location]: https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#parameterIn
96+
/// [parameter location]: https://spec.openapis.org/oas/v3.1.0#parameterIn
9797
//
9898
// FIXME: Implement
9999
// parameters: BTreeMap<String, Any | {expression}>,
@@ -103,7 +103,7 @@ pub enum Link {
103103

104104
// FIXME: Implement
105105
// /// A literal value or
106-
// /// [{expression}](https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#runtimeExpression)
106+
// /// [{expression}](https://spec.openapis.org/oas/v3.1.0#runtimeExpression)
107107
// /// to use as a request body when calling the target operation.
108108
// #[serde(rename = "requestBody")]
109109
// request_body: Any | {expression}
@@ -123,7 +123,7 @@ pub enum Link {
123123
///
124124
/// Only "x-" prefixed keys are collected, and the prefix is stripped.
125125
///
126-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#specification-extensions>.
126+
/// See <https://spec.openapis.org/oas/v3.1.0#specification-extensions>.
127127
#[serde(flatten, with = "spec_extensions")]
128128
extensions: BTreeMap<String, serde_json::Value>,
129129
},

‎crates/oas3/src/spec/media_type.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ use super::{Encoding, Error, Example, MediaTypeExamples, ObjectOrReference, Obje
66

77
/// Each Media Type Object provides schema and examples for the media type identified by its key.
88
///
9-
/// See <https://github.com/OAI/OpenAPI-Specification/blob/HEAD/versions/3.1.0.md#media-type-object>.
9+
/// See <https://spec.openapis.org/oas/v3.1.0#media-type-object>.
1010
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Default)]
1111
pub struct MediaType {
1212
/// The schema defining the type used for the request body.

0 commit comments

Comments
 (0)