From 3515ccc6bd5cfe5dd9ce324273cc50a0b10ffcfb Mon Sep 17 00:00:00 2001 From: River Phillips Date: Tue, 2 Jan 2024 14:16:04 +0000 Subject: [PATCH 1/4] fix(docs): replace AsyncAPI spec urls with valid ones Signed-off-by: River Phillips --- docs/features/software-catalog/descriptor-format.md | 4 ++-- plugins/api-docs/README.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/features/software-catalog/descriptor-format.md b/docs/features/software-catalog/descriptor-format.md index 924c59a6fa..c094dbfd09 100644 --- a/docs/features/software-catalog/descriptor-format.md +++ b/docs/features/software-catalog/descriptor-format.md @@ -782,7 +782,7 @@ Describes the following entity kind: An API describes an interface that can be exposed by a component. The API can be defined in different formats, like [OpenAPI](https://swagger.io/specification/), -[AsyncAPI](https://www.asyncapi.com/docs/specifications/latest/), +[AsyncAPI](https://www.asyncapi.com/docs/reference/specification/v3.0.0), [GraphQL](https://graphql.org/learn/schema/), [gRPC](https://developers.google.com/protocol-buffers), or other formats. @@ -838,7 +838,7 @@ The current set of well-known and common values for this field is: - `openapi` - An API definition in YAML or JSON format based on the [OpenAPI](https://swagger.io/specification/) version 2 or version 3 spec. - `asyncapi` - An API definition based on the - [AsyncAPI](https://www.asyncapi.com/docs/specifications/latest/) spec. + [AsyncAPI](https://www.asyncapi.com/docs/reference/specification/v3.0.0) spec. - `graphql` - An API definition based on [GraphQL schemas](https://spec.graphql.org/) for consuming [GraphQL](https://graphql.org/) based APIs. diff --git a/plugins/api-docs/README.md b/plugins/api-docs/README.md index 79c4581e79..beee40d1fa 100644 --- a/plugins/api-docs/README.md +++ b/plugins/api-docs/README.md @@ -13,7 +13,7 @@ The plugin provides a standalone list of APIs, as well as an integration into th Right now, the following API formats are supported: - [OpenAPI](https://swagger.io/specification/) 2 & 3 -- [AsyncAPI](https://www.asyncapi.com/docs/specifications/latest/) +- [AsyncAPI](https://www.asyncapi.com/docs/reference/specification/v3.0.0) - [GraphQL](https://graphql.org/learn/schema/) Other formats are displayed as plain text, but this can easily be extended. From 21365bd5f6d2cfda971016ef4ea65196cd93fdaa Mon Sep 17 00:00:00 2001 From: River Phillips Date: Tue, 2 Jan 2024 14:28:00 +0000 Subject: [PATCH 2/4] chore: add changeset Signed-off-by: River Phillips --- .changeset/fluffy-bugs-guess.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/fluffy-bugs-guess.md diff --git a/.changeset/fluffy-bugs-guess.md b/.changeset/fluffy-bugs-guess.md new file mode 100644 index 0000000000..91e10b613d --- /dev/null +++ b/.changeset/fluffy-bugs-guess.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-api-docs': patch +--- + +Update docs to link to correct Async API spec From 76b2ea6a495b331528cba397131ac8389fccc242 Mon Sep 17 00:00:00 2001 From: River Phillips Date: Tue, 2 Jan 2024 15:18:20 +0000 Subject: [PATCH 3/4] fix: use latest AsyncAPI instead of specific version Signed-off-by: River Phillips --- docs/features/software-catalog/descriptor-format.md | 4 ++-- plugins/api-docs/README.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/features/software-catalog/descriptor-format.md b/docs/features/software-catalog/descriptor-format.md index c094dbfd09..526ba15072 100644 --- a/docs/features/software-catalog/descriptor-format.md +++ b/docs/features/software-catalog/descriptor-format.md @@ -782,7 +782,7 @@ Describes the following entity kind: An API describes an interface that can be exposed by a component. The API can be defined in different formats, like [OpenAPI](https://swagger.io/specification/), -[AsyncAPI](https://www.asyncapi.com/docs/reference/specification/v3.0.0), +[AsyncAPI](https://www.asyncapi.com/docs/reference/specification/latest), [GraphQL](https://graphql.org/learn/schema/), [gRPC](https://developers.google.com/protocol-buffers), or other formats. @@ -838,7 +838,7 @@ The current set of well-known and common values for this field is: - `openapi` - An API definition in YAML or JSON format based on the [OpenAPI](https://swagger.io/specification/) version 2 or version 3 spec. - `asyncapi` - An API definition based on the - [AsyncAPI](https://www.asyncapi.com/docs/reference/specification/v3.0.0) spec. + [AsyncAPI](https://www.asyncapi.com/docs/reference/specification/latest) spec. - `graphql` - An API definition based on [GraphQL schemas](https://spec.graphql.org/) for consuming [GraphQL](https://graphql.org/) based APIs. diff --git a/plugins/api-docs/README.md b/plugins/api-docs/README.md index beee40d1fa..4d4342de61 100644 --- a/plugins/api-docs/README.md +++ b/plugins/api-docs/README.md @@ -13,7 +13,7 @@ The plugin provides a standalone list of APIs, as well as an integration into th Right now, the following API formats are supported: - [OpenAPI](https://swagger.io/specification/) 2 & 3 -- [AsyncAPI](https://www.asyncapi.com/docs/reference/specification/v3.0.0) +- [AsyncAPI](https://www.asyncapi.com/docs/reference/specification/latest) - [GraphQL](https://graphql.org/learn/schema/) Other formats are displayed as plain text, but this can easily be extended. From 2c0d46332ba5a44c708954bc857239f1089a136e Mon Sep 17 00:00:00 2001 From: River Phillips Date: Tue, 2 Jan 2024 15:55:17 +0000 Subject: [PATCH 4/4] chore: remove unnecessary changeset Signed-off-by: River Phillips --- .changeset/fluffy-bugs-guess.md | 5 ----- 1 file changed, 5 deletions(-) delete mode 100644 .changeset/fluffy-bugs-guess.md diff --git a/.changeset/fluffy-bugs-guess.md b/.changeset/fluffy-bugs-guess.md deleted file mode 100644 index 91e10b613d..0000000000 --- a/.changeset/fluffy-bugs-guess.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@backstage/plugin-api-docs': patch ---- - -Update docs to link to correct Async API spec