docs: update OpenAPI documentation

This commit is contained in:
Maël Gangloff 2025-12-07 17:12:24 +01:00
parent 5a31e53234
commit f10940e7bf
No known key found for this signature in database
GPG Key ID: 11FDC81C24A7F629
2 changed files with 10 additions and 2 deletions

View File

@ -1,7 +1,15 @@
api_platform: api_platform:
title: Domain Watchdog API title: Domain Watchdog API
version: 1.0.0 description: List of operations that can be performed on the Domain Watchdog project API. These endpoints allow you to perform any useful action related to domain name searches, managing Watchlists and Connectors, etc.
version: 1.3.5
asset_package: 'api_platform' asset_package: 'api_platform'
openapi:
contact:
name: Domain Watchdog
url: https://github.com/maelgangloff/domain-watchdog/
license:
name: GNU Affero General Public License v3.0
url: https://www.gnu.org/licenses/agpl-3.0.txt
formats: formats:
jsonld: [ 'application/ld+json' ] jsonld: [ 'application/ld+json' ]
xml: [ 'application/xml' ] xml: [ 'application/xml' ]

View File

@ -67,7 +67,7 @@ export default defineConfig({
}, },
{label: 'Definitions', autogenerate: {directory: 'definitions'}, collapsed: false, translations: {fr: 'Définitions'}}, {label: 'Definitions', autogenerate: {directory: 'definitions'}, collapsed: false, translations: {fr: 'Définitions'}},
{label: 'Interoperability', items: [domainWatchdogSidebarGroup], badge: {text: 'DEV', class: 'caution'}, collapsed: true}, {label: 'Interoperability', items: [domainWatchdogSidebarGroup], badge: {text: 'DEV', class: 'caution'}, collapsed: true},
{label: 'Legal', autogenerate: {directory: 'legal'}, collapsed: true, translations: {fr: 'Légal'}}, {label: 'Legal', autogenerate: {directory: 'legal'}, collapsed: false, translations: {fr: 'Légal'}},
{slug: 'acknowledgments', translations: {fr: 'Remerciements'}}, {slug: 'acknowledgments', translations: {fr: 'Remerciements'}},
], ],
locales: { locales: {