Skip to content

Add OpenAPI Spec Examples #7

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

Open
travis-delker-itential wants to merge 2 commits into
base: devel
Choose a base branch
from
Open

Add OpenAPI Spec Examples #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9f4e07a
add OpenAPI for P6 with Basic and CLient Credentials Auth
travis-delker-itential Jul 2, 2025
536f901
simplified API specs to 1 method
travis-delker-itential Jul 3, 2025
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
60 changes: 60 additions & 0 deletions Itential/Platform/OpenAPISpecs/OpenApiWhoamI-BasicAuth.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
{
"openapi": "3.1.0",
"info": {
"title": "IAP",
"version": "1.0.0",
"description": "A simple OpenAPI example"
},
"paths": {
"/whoami": {
"get": {
"summary": "Gets the authorization data for the logged in user",
"description": "Gets the authorization data for the logged in user",
"tags": ["authentication"],
"operationId": "WhoAmI",
"responses": {
"200": {
"description": "Authorization data for a user",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object",
"properties": {}
}
}
}
},
"500": {
"description": "Error response from API"
}
},
"security": [
{
"QueryAuth": [],
"CookieAuth": [],
"BasicAuth": []
}
]
}
}
},
"components": {
"securitySchemes":{
"CookieAuth": {
"type": "apiKey",
"name": "token",
"in": "cookie"
},
"QueryAuth": {
"type": "apiKey",
"name": "token",
"in": "query"
},
"BasicAuth": {
"type": "http",
"scheme": "basic"
}
}
}
}
53 changes: 53 additions & 0 deletions Itential/Platform/OpenAPISpecs/OpenApiWhoamI-ClientCreds.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
{
"openapi": "3.1.0",
"info": {
"title": "IAP",
"version": "1.0.0",
"description": "A simple OpenAPI example"
},
"paths": {
"/whoami": {
"get": {
"summary": "Gets the authorization data for the logged in user",
"description": "Gets the authorization data for the logged in user",
"tags": ["authentication"],
"operationId": "WhoAmI",
"responses": {
"200": {
"description": "Authorization data for a user",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object",
"properties": {}
}
}
}
},
"500": {
"description": "Error response from API"
}
},
"security": [
{
"ServiceAccount": []
}
]
}
}
},
"components": {
"securitySchemes": {
"ServiceAccount": {
"type": "oauth2",
"flows": {
"clientCredentials": {
"tokenUrl": "https://platform/oauth/token",
"scopes": {}
}
}
}
}
}
}