From bab8807dc00833d3699a68bb1db65e77a99fd488 Mon Sep 17 00:00:00 2001 From: Polo M2B Date: Thu, 21 Sep 2023 12:59:09 +0200 Subject: [PATCH] Enrich spec with description --- api/config/packages/api_platform.yaml | 3 +++ docs/openapi.json | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/api/config/packages/api_platform.yaml b/api/config/packages/api_platform.yaml index df00eea..e52ef1e 100644 --- a/api/config/packages/api_platform.yaml +++ b/api/config/packages/api_platform.yaml @@ -1,6 +1,9 @@ api_platform: title: Hello API Platform version: 1.0.0 + description: | + This documentation is generated from API Platform, GitHub action + connected to this repo: https://github.com/Polo2/my-api-demo # Mercure integration, remove if unwanted mercure: ~ # Good defaults for REST APIs diff --git a/docs/openapi.json b/docs/openapi.json index 3225ffd..ae48482 100644 --- a/docs/openapi.json +++ b/docs/openapi.json @@ -2,7 +2,7 @@ "openapi": "3.0.0", "info": { "title": "Hello API Platform", - "description": "", + "description": "This documentation is generated from API Platform, GitHub action\nconnected to this repo: https://github.com/Polo2/my-api-demo", "version": "1.0.0" }, "servers": [