-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
15 additions
and
15 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 |
---|---|---|
|
@@ -2,21 +2,21 @@ openapi: 3.1.0 | |
info: | ||
version: '1.0' | ||
title: passkey-server | ||
summary: 'OpenAPI Spec for creating, managing and using passkeys' | ||
description: 'This api shall represent the private and public endpoints for Passkey registration, management and authentication' | ||
summary: 'OpenAPI Spec for creating, managing, and using passkeys' | ||
description: 'This API shall represent the private and public endpoints for passkey registration, management, and authentication' | ||
termsOfService: 'https://www.hanko.io/terms' | ||
contact: | ||
email: [email protected] | ||
url: hanko.io | ||
name: [email protected] | ||
name: Hanko Dev Team | ||
license: | ||
url: 'https://www.gnu.org/licenses/gpl-3.0.de.html' | ||
name: GPLv3 | ||
servers: | ||
- url: 'http://{host}:8000/{path_prefix}' | ||
variables: | ||
host: | ||
description: Host Part of the URL | ||
description: Host part of the URL | ||
default: localhost | ||
path_prefix: | ||
description: Path prefix | ||
|
@@ -70,7 +70,7 @@ paths: | |
$ref: '#/components/requestBodies/patch-credential' | ||
responses: | ||
'204': | ||
description: No Content | ||
description: No content | ||
'400': | ||
$ref: '#/components/responses/error' | ||
'401': | ||
|
@@ -98,7 +98,7 @@ paths: | |
- $ref: '#/components/parameters/tenant_id' | ||
responses: | ||
'204': | ||
description: No Content | ||
description: No content | ||
'400': | ||
$ref: '#/components/responses/error' | ||
'401': | ||
|
@@ -143,7 +143,7 @@ paths: | |
- url: 'http://{host}:8000/{path_prefix}' | ||
variables: | ||
host: | ||
description: Host Part of the URL | ||
description: Host part of the URL | ||
default: localhost | ||
path_prefix: | ||
description: Path prefix | ||
|
@@ -153,7 +153,7 @@ paths: | |
tags: | ||
- credentials | ||
summary: Finish Passkey Registration | ||
description: Finish credential registration process. | ||
description: Finish credential registration process | ||
operationId: post-registration-finalize | ||
parameters: | ||
- $ref: '#/components/parameters/tenant_id' | ||
|
@@ -203,7 +203,7 @@ paths: | |
- url: 'http://{host}:8000/{path_prefix}' | ||
variables: | ||
host: | ||
description: Host Part of the URL | ||
description: Host part of the URL | ||
default: localhost | ||
path_prefix: | ||
description: Path prefix | ||
|
@@ -233,7 +233,7 @@ paths: | |
- url: 'http://{host}:8000/{path_prefix}' | ||
variables: | ||
host: | ||
description: Host Part of the URL | ||
description: Host part of the URL | ||
default: localhost | ||
path_prefix: | ||
description: Path prefix | ||
|
@@ -255,16 +255,16 @@ paths: | |
- url: 'http://{host}:8000/{path_prefix}' | ||
variables: | ||
host: | ||
description: Host Part of the URL | ||
description: Host part of the URL | ||
default: localhost | ||
path_prefix: | ||
description: Path prefix | ||
default: '' | ||
tags: | ||
- name: credentials | ||
description: Represents all objects which are related to webauthn credentials | ||
description: Represents all objects which are related to WebAuthn credentials | ||
- name: webauthn | ||
description: Represents all objects which are related to webauthn in common | ||
description: Represents all objects which are related to WebAuthn in common | ||
components: | ||
parameters: | ||
user_id: | ||
|
@@ -306,7 +306,7 @@ components: | |
X-API-KEY: | ||
name: apiKey | ||
in: header | ||
description: Secret API Key | ||
description: Secret API key | ||
required: true | ||
schema: | ||
type: string | ||
|
@@ -434,7 +434,7 @@ components: | |
- backup_eligible | ||
- backup_state | ||
error: | ||
description: Error Response with detailed information | ||
description: Error response with detailed information | ||
content: | ||
application/json: | ||
schema: | ||
|