From f7fe7a1a9d4547985c5b4da7a306ce8461656a1d Mon Sep 17 00:00:00 2001 From: Javier Cicchelli Date: Tue, 7 Oct 2025 17:30:14 +0200 Subject: [PATCH] Improved the information of the "info" property of the OpenAPI specification documentation in the library target. --- Sources/AmiiboService/openapi.yaml | 45 ++++++++++++++++++++++++++---- 1 file changed, 40 insertions(+), 5 deletions(-) diff --git a/Sources/AmiiboService/openapi.yaml b/Sources/AmiiboService/openapi.yaml index 5762fe4..e3fba9a 100644 --- a/Sources/AmiiboService/openapi.yaml +++ b/Sources/AmiiboService/openapi.yaml @@ -10,14 +10,49 @@ # # ===----------------------------------------------------------------------=== -openapi: '3.1.0' +openapi: '3.1.1' info: - title: Amiibo API service - description: The Amiibo API RESTful service. - version: 1.0.0 + title: Amiibo API + summary: A RESTFul API for Amiibo. + description: | + # information + + _AmiiboAPI_ 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.* + * *Other reports collected by the respective companies that own the rights are not our responsibility.* + * *User agrees that the use of this API is entirely at user's own risks.* + * *You will require your end users to comply with (and not knowingly enable them to violate) applicable law, regulation, and the Terms.* + * *You will comply with all applicable law, regulation, and third party rights (including without limitation laws regarding the import or export of data or software, privacy, and local laws). You will not use the APIs to encourage or promote illegal activity or violation of third party rights.* + * *These Terms and Conditions are subject to change without notice, from time to time in our sole discretion.* + version: v1.0.0 + termsOfService: https://www.amiiboapi.com/docs/#termscondition + contact: + name: FAQ + url: https://www.amiiboapi.com/faq/ + license: + name: MIT license + identifier: MIT servers: - url: https://www.amiiboapi.com/api - description: Amiibo API service (live) + description: Live service +tags: + - name: Amiibo + description: Amiibo-related endpoints. + - name: Game + description: Game-related endpoints. + - name: Service + description: Service-related endpoints. +externalDocs: + url: https://www.amiiboapi.com/docs + description: Amiibo API documentation paths: /amiibo: get: