Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: add serviceinfo openapi spec #2

Merged
merged 1 commit into from
Nov 4, 2024
Merged

feat: add serviceinfo openapi spec #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 83 additions & 0 deletions schemas/serviceinfo/openapi.json
View file
Open in desktop
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."
}
}
}
}
}
}
}
}
}
Loading