-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from SecretiveShell/main
feat: add serviceinfo openapi spec
- Loading branch information
Showing
1 changed file
with
83 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| { | ||
| "openapi": "3.0.0", | ||
| "info": { | ||
| "version": "0.2", | ||
| "title": "Service Info API", | ||
| "description": "An API to provide service information including software details and API specifications." | ||
| }, | ||
| "components": { | ||
| "schemas": { | ||
| "ServiceInfo": { | ||
| "type": "object", | ||
| "required": ["version", "software", "api"], | ||
| "properties": { | ||
| "version": { | ||
| "type": "string", | ||
| "description": "The version of the service info specification." | ||
| }, | ||
| "software": { | ||
| "type": "object", | ||
| "required": ["name", "version", "repository", "homepage"], | ||
| "properties": { | ||
| "name": { | ||
| "type": "string", | ||
| "description": "The name of the software." | ||
| }, | ||
| "version": { | ||
| "type": "string", | ||
| "description": "The version of the software." | ||
| }, | ||
| "repository": { | ||
| "type": "string", | ||
| "format": "uri", | ||
| "description": "The URL of the software's source code repository." | ||
| }, | ||
| "homepage": { | ||
| "type": "string", | ||
| "format": "uri", | ||
| "description": "The URL to the software's homepage." | ||
| }, | ||
| "logo": { | ||
| "type": "string", | ||
| "format": "uri", | ||
| "description": "A URL to an image of the software logo.", | ||
| "nullable": true | ||
| } | ||
| } | ||
| }, | ||
| "api": { | ||
| "type": "object", | ||
| "additionalProperties": { | ||
| "type": "object", | ||
| "required": ["name", "version", "rel_url", "documentation"], | ||
| "properties": { | ||
| "name": { | ||
| "type": "string", | ||
| "description": "The name of the software API." | ||
| }, | ||
| "version": { | ||
| "type": "string", | ||
| "description": "The version of the API implemented by the software." | ||
| }, | ||
| "base_url": { | ||
| "type": "string", | ||
| "format": "uri", | ||
| "description": "The absolute URL to the API base.", | ||
| "nullable": true | ||
| }, | ||
| "rel_url": { | ||
| "type": "string", | ||
| "description": "A relative URL to the API base." | ||
| }, | ||
| "documentation": { | ||
| "type": "string", | ||
| "description": "A relative or absolute URL to the API documentation." | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |