Skip to content

Commit b89bc6d

Browse files
committed
Updated API name and description
1 parent 813a912 commit b89bc6d

3 files changed

Lines changed: 12 additions & 6 deletions

File tree

config/packages/api_platform.yaml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
api_platform:
2-
title: 'ITKsites Detection API'
3-
description: 'REST API for ingesting server detection results from the ITK sites server harvester. Detection results are processed asynchronously to track servers, sites, domains, packages, modules, Docker images, and git repositories.'
2+
title: 'ITKsites API'
3+
description: |
4+
REST API for ingesting server detection results from the ITK sites server harvester. Detection results are processed asynchronously to track servers, sites, domains, packages, modules, Docker images, and git repositories.
5+
6+
The API also provides read-only access to information on servers and sites created by processing detection results.
47
version: '1.0.0'
58

69
mapping:

public/api-spec-v1.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"openapi": "3.1.0",
33
"info": {
4-
"title": "ITKsites Detection API",
5-
"description": "REST API for ingesting server detection results from the ITK sites server harvester. Detection results are processed asynchronously to track servers, sites, domains, packages, modules, Docker images, and git repositories.",
4+
"title": "ITKsites API",
5+
"description": "REST API for ingesting server detection results from the ITK sites server harvester. Detection results are processed asynchronously to track servers, sites, domains, packages, modules, Docker images, and git repositories.\n\nThe API also provides read-only access to information on servers and sites created by processing detection results.",
66
"version": "1.0.0"
77
},
88
"servers": [

public/api-spec-v1.yaml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
openapi: 3.1.0
22
info:
3-
title: 'ITKsites Detection API'
4-
description: 'REST API for ingesting server detection results from the ITK sites server harvester. Detection results are processed asynchronously to track servers, sites, domains, packages, modules, Docker images, and git repositories.'
3+
title: 'ITKsites API'
4+
description: |-
5+
REST API for ingesting server detection results from the ITK sites server harvester. Detection results are processed asynchronously to track servers, sites, domains, packages, modules, Docker images, and git repositories.
6+
7+
The API also provides read-only access to information on servers and sites created by processing detection results.
58
version: 1.0.0
69
servers:
710
- url: 'https://itksites.local.itkdev.dk'

0 commit comments

Comments
 (0)