From 16c62a5df892b44d4effaa348078ef045b06808b Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Wed, 15 Oct 2025 00:25:15 +0200 Subject: [PATCH] Improved the definition of the "info" section for the OpenAPI specification document in the library target. --- Sources/AmiiboService/openapi.yaml | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/Sources/AmiiboService/openapi.yaml b/Sources/AmiiboService/openapi.yaml index 318c38a..bab587b 100644 --- a/Sources/AmiiboService/openapi.yaml +++ b/Sources/AmiiboService/openapi.yaml @@ -17,15 +17,16 @@ info: title: Amiibo API summary: A RESTFul API for Amiibo. description: | - # information + # Information - _AmiiboAPI_ is primarily used for educational purposes. + The [AmiiboAPI](https://www.amiiboapi.com) service is primarily used for educational purposes. This is a **reading-only API**. Only HTTP GET method is allowed by this API. **No authentication** is required to use this API. All resources are allowed to access. If you are going to be calling this API regularly. We recommend that you use **caching** on your system. # Terms & Conditions + By using our API, you hereby accepted the following terms and conditions: * *This API has no affiliation with Nintendo or any other companies that own the rights to it.* @@ -42,6 +43,9 @@ info: license: name: MIT license identifier: MIT +externalDocs: + url: https://www.amiiboapi.com/docs + description: Amiibo API documentation servers: - url: https://www.amiiboapi.com/api description: Live service @@ -52,9 +56,6 @@ tags: description: Game-related endpoints. - name: Service description: Service-related endpoints. -externalDocs: - url: https://www.amiiboapi.com/docs - description: Amiibo API documentation paths: /amiibo: get: