diff --git a/spec/json/twilio_verify_passkeys_v1.json b/spec/json/twilio_verify_passkeys_v1.json index 56e0b898..db4d993e 100644 --- a/spec/json/twilio_verify_passkeys_v1.json +++ b/spec/json/twilio_verify_passkeys_v1.json @@ -13,25 +13,25 @@ "type": "object", "properties": { "sid": { - "$ref": "schemas.yaml#/FactorSID" + "$ref": "#/components/schemas/FactorSID" }, "friendly_name": { "type": "string" }, "account_sid": { - "$ref": "schemas.yaml#/AccountSID" + "$ref": "#/components/schemas/AccountSID" }, "service_sid": { - "$ref": "schemas.yaml#/ServiceSID" + "$ref": "#/components/schemas/ServiceSID" }, "entity_sid": { - "$ref": "schemas.yaml#/EntitySID" + "$ref": "#/components/schemas/EntitySID" }, "entity_identity": { "type": "string" }, "factor_type": { - "$ref": "schemas.yaml#/FactorType" + "$ref": "#/components/schemas/FactorType" }, "status": { "type": "string", @@ -46,12 +46,12 @@ "binding": { "title": "PasskeyBinding", "description": "The public key credential and metadata of a verified passkey binding.", - "$ref": "schemas.yaml#/PasskeyFactorBinding" + "$ref": "#/components/schemas/PasskeyFactorBinding" }, "config": { "type": "object", "description": "The type-specific factor configuration.", - "$ref": "schemas.yaml#/PasskeyFactorConfig" + "$ref": "#/components/schemas/PasskeyFactorConfig" }, "date_created": { "type": "string", @@ -88,15 +88,15 @@ "properties": { "credential_id": { "description": "A unique identifier for this credential so that it can be requested for future authentications.", - "$ref": "schemas.yaml#/Base64UrlString" + "$ref": "#/components/schemas/Base64UrlString" }, "credential_public_key": { "type": "string", "description": "A COSE-encoded public key. This public key will be stored on the server associated with a user's account and be used for future authentications.", - "$ref": "schemas.yaml#/Base64UrlString" + "$ref": "#/components/schemas/Base64UrlString" }, "transports": { - "$ref": "schemas.yaml#/TransportTypes" + "$ref": "#/components/schemas/TransportTypes" }, "flags": { "type": "array", @@ -130,7 +130,7 @@ "description": "A flag indicating that the authenticator may be cloned." }, "authenticator_attachment": { - "$ref": "schemas.yaml#/AuthenticatorAttachment" + "$ref": "#/components/schemas/AuthenticatorAttachment" } } } @@ -168,16 +168,16 @@ "properties": { "authenticator_attachment": { "description": "A flag indicating a requirement to attach only to a certain type of authenticator.", - "$ref": "schemas.yaml#/ExpandedAuthenticatorAttachment", + "$ref": "#/components/schemas/ExpandedAuthenticatorAttachment", "default": "any" }, "discoverable_credentials": { - "$ref": "schemas.yaml#/ResidentKey", + "$ref": "#/components/schemas/ResidentKey", "description": "A flag indicating the level of preference for discoverable credentials.", "default": "preferred" }, "user_verification": { - "$ref": "schemas.yaml#/UserVerification", + "$ref": "#/components/schemas/UserVerification", "default": "preferred", "description": "Whether user identity verification (via biometrics or PIN) is required." } @@ -193,14 +193,14 @@ "title": "PasskeyFactorConfig", "allOf": [ { - "$ref": "schemas.yaml#/PasskeyFactorConfigRequest" + "$ref": "#/components/schemas/PasskeyFactorConfigRequest" }, { "title": "PasskeyCreationRequest", "type": "object", "properties": { "creation_request": { - "$ref": "schemas.yaml#/PublicKeyCredentialCreationOptions" + "$ref": "#/components/schemas/PublicKeyCredentialCreationOptions" } } } @@ -213,17 +213,17 @@ "properties": { "id": { "description": "A [base64url](https://base64.guru/standards/base64url) encoded representation of `rawId`.", - "$ref": "schemas.yaml#/Base64UrlString" + "$ref": "#/components/schemas/Base64UrlString" }, "rawId": { "description": "The globally unique identifier for this `PublicKeyCredential`.", - "$ref": "schemas.yaml#/Base64UrlString" + "$ref": "#/components/schemas/Base64UrlString" }, "authenticatorAttachment": { - "$ref": "schemas.yaml#/AuthenticatorAttachment" + "$ref": "#/components/schemas/AuthenticatorAttachment" }, "type": { - "$ref": "schemas.yaml#/PublicKeyType" + "$ref": "#/components/schemas/PublicKeyType" }, "response": { "title": "AuthenticatorAttestationResponse", @@ -232,14 +232,14 @@ "properties": { "attestationObject": { "description": "The authenticator data and an attestation statement for a new key pair generated by the authenticator.", - "$ref": "schemas.yaml#/CBORString" + "$ref": "#/components/schemas/CBORString" }, "clientDataJSON": { "description": "This property contains the JSON-compatible serialization of the data passed from the browser to the authenticator in order to generate this credential.", - "$ref": "schemas.yaml#/Base64UrlString" + "$ref": "#/components/schemas/Base64UrlString" }, "transports": { - "$ref": "schemas.yaml#/TransportTypes" + "$ref": "#/components/schemas/TransportTypes" } } } @@ -254,22 +254,22 @@ "type": "object", "properties": { "sid": { - "$ref": "schemas.yaml#/ChallengeSID" + "$ref": "#/components/schemas/ChallengeSID" }, "account_sid": { - "$ref": "schemas.yaml#/AccountSID" + "$ref": "#/components/schemas/AccountSID" }, "service_sid": { - "$ref": "schemas.yaml#/ServiceSID" + "$ref": "#/components/schemas/ServiceSID" }, "factor_sid": { - "$ref": "schemas.yaml#/FactorSID" + "$ref": "#/components/schemas/FactorSID" }, "factor_type": { - "$ref": "schemas.yaml#/FactorType" + "$ref": "#/components/schemas/FactorType" }, "entity_sid": { - "$ref": "schemas.yaml#/EntitySID" + "$ref": "#/components/schemas/EntitySID" }, "entity_identity": { "type": "string" @@ -286,7 +286,7 @@ "details": { "type": "object", "description": "The challenge details.", - "$ref": "schemas.yaml#/PublicKeyChallenge" + "$ref": "#/components/schemas/PublicKeyChallenge" }, "date_created": { "type": "string", @@ -314,31 +314,31 @@ "properties": { "id": { "description": "A [base64url](https://base64.guru/standards/base64url) encoded representation of `rawId`.", - "$ref": "schemas.yaml#/Base64UrlString" + "$ref": "#/components/schemas/Base64UrlString" }, "rawId": { "description": "The globally unique identifier for this `PublicKeyCredential`.", - "$ref": "schemas.yaml#/Base64UrlString" + "$ref": "#/components/schemas/Base64UrlString" }, "authenticatorAttachment": { - "$ref": "schemas.yaml#/AuthenticatorAttachment" + "$ref": "#/components/schemas/AuthenticatorAttachment" }, "type": { - "$ref": "schemas.yaml#/PublicKeyType" + "$ref": "#/components/schemas/PublicKeyType" }, "response": { "title": "AuthenticatorAssertionResponse", "type": "object", "properties": { "authenticatorData": { - "$ref": "schemas.yaml#/CBORString" + "$ref": "#/components/schemas/CBORString" }, "clientDataJSON": { "description": "This property contains the JSON-compatible serialization of the data passed from the browser to the authenticator in order to generate this credential.", - "$ref": "schemas.yaml#/Base64UrlString" + "$ref": "#/components/schemas/Base64UrlString" }, "signature": { - "$ref": "schemas.yaml#/Base64UrlString", + "$ref": "#/components/schemas/Base64UrlString", "description": "An assertion signature over `authenticatorData` and `clientDataJSON`.\nThe assertion signature is created with the private key of the key pair that was created during the originating `navigator.credentials.create()` call\nand verified using the public key of that same key pair." }, "userHandle": { @@ -356,7 +356,7 @@ "title": "EntitySID", "properties": { "sid": { - "$ref": "schemas.yaml#/EntitySID" + "$ref": "#/components/schemas/EntitySID" } }, "additionalProperties": false @@ -489,7 +489,7 @@ "description": "An object describing the user account for which the credential is generated.", "properties": { "id": { - "$ref": "schemas.yaml#/Base64UrlString", + "$ref": "#/components/schemas/Base64UrlString", "description": "The unique ID for the user account. This property will contain the base64url-encoded entity SID and should not be displayed to the end user.\nThe `user.id` will later be used for authentication via discoverable credentials, where this same identifier will be passed via the `userHandle` property." }, "name": { @@ -508,7 +508,7 @@ ] }, "challenge": { - "$ref": "schemas.yaml#/Base64UrlString", + "$ref": "#/components/schemas/Base64UrlString", "description": "A string generated as a cryptographic challenge, to be signed by the authenticator and sent back as part of the registration process.\nThis will contain a base64url-encoded challenge SID." }, "pubKeyCredParams": { @@ -518,10 +518,10 @@ "type": "object", "properties": { "type": { - "$ref": "schemas.yaml#/PublicKeyType" + "$ref": "#/components/schemas/PublicKeyType" }, "alg": { - "$ref": "schemas.yaml#/PublicKeyAlgorithm" + "$ref": "#/components/schemas/PublicKeyAlgorithm" } }, "required": [ @@ -542,13 +542,13 @@ "type": "object", "properties": { "type": { - "$ref": "schemas.yaml#/PublicKeyType" + "$ref": "#/components/schemas/PublicKeyType" }, "id": { "type": "string" }, "transports": { - "$ref": "schemas.yaml#/TransportTypes" + "$ref": "#/components/schemas/TransportTypes" } }, "required": [ @@ -562,17 +562,17 @@ "description": "An object whose properties are criteria used to filter out the potential authenticators for the credential creation operation.", "properties": { "authenticatorAttachment": { - "$ref": "schemas.yaml#/AuthenticatorAttachment" + "$ref": "#/components/schemas/AuthenticatorAttachment" }, "requireResidentKey": { "type": "boolean", "description": "A flag indicating that the authenticator must support the resident key requirement." }, "residentKey": { - "$ref": "schemas.yaml#/ResidentKey" + "$ref": "#/components/schemas/ResidentKey" }, "userVerification": { - "$ref": "schemas.yaml#/UserVerification" + "$ref": "#/components/schemas/UserVerification" } } }, @@ -608,17 +608,17 @@ "properties": { "id": { "description": "A [base64url](https://base64.guru/standards/base64url) encoded representation of `rawId`.", - "$ref": "schemas.yaml#/Base64UrlString" + "$ref": "#/components/schemas/Base64UrlString" }, "rawId": { "description": "The globally unique identifier for this `PublicKeyCredential`.", - "$ref": "schemas.yaml#/Base64UrlString" + "$ref": "#/components/schemas/Base64UrlString" }, "authenticatorAttachment": { - "$ref": "schemas.yaml#/AuthenticatorAttachment" + "$ref": "#/components/schemas/AuthenticatorAttachment" }, "type": { - "$ref": "schemas.yaml#/PublicKeyType" + "$ref": "#/components/schemas/PublicKeyType" } }, "required": [ @@ -688,7 +688,7 @@ "type": "string" }, "allowCredentials": { - "$ref": "schemas.yaml#/AllowCredentials" + "$ref": "#/components/schemas/AllowCredentials" }, "timeout": { "type": "integer", @@ -696,7 +696,7 @@ "description": "The time in milliseconds that the challenge is valid for." }, "userVerification": { - "$ref": "schemas.yaml#/UserVerification", + "$ref": "#/components/schemas/UserVerification", "default": "preferred" }, "extensions": { @@ -719,13 +719,13 @@ "properties": { "id": { "description": "The ID of the public key credential to retrieve. This value is mirrored by the `rawId` property of the `PublicKeyCredential` object", - "$ref": "schemas.yaml#/Base64UrlString" + "$ref": "#/components/schemas/Base64UrlString" }, "type": { - "$ref": "schemas.yaml#/PublicKeyType" + "$ref": "#/components/schemas/PublicKeyType" }, "transports": { - "$ref": "schemas.yaml#/TransportTypes" + "$ref": "#/components/schemas/TransportTypes" } } } @@ -773,7 +773,7 @@ "parameters": [ { "schema": { - "$ref": "schemas.yaml#/ServiceSID" + "$ref": "#/components/schemas/ServiceSID" }, "name": "service_sid", "in": "path", @@ -786,7 +786,7 @@ "content": { "application/json": { "schema": { - "$ref": "schemas.yaml#/Factor" + "$ref": "#/components/schemas/Factor" } } } @@ -804,13 +804,13 @@ "type": "string" }, "factor_type": { - "$ref": "schemas.yaml#/FactorType" + "$ref": "#/components/schemas/FactorType" }, "entity": { - "$ref": "schemas.yaml#/EntityIdentifier" + "$ref": "#/components/schemas/EntityIdentifier" }, "config": { - "$ref": "schemas.yaml#/PasskeyFactorConfigRequest" + "$ref": "#/components/schemas/PasskeyFactorConfigRequest" } }, "required": [ @@ -832,7 +832,7 @@ "name": "service_sid", "in": "path", "schema": { - "$ref": "schemas.yaml#/ServiceSID" + "$ref": "#/components/schemas/ServiceSID" }, "required": true }, @@ -840,7 +840,7 @@ "name": "entity_sid", "in": "query", "schema": { - "$ref": "schemas.yaml#/EntitySID" + "$ref": "#/components/schemas/EntitySID" } }, { @@ -854,14 +854,14 @@ "name": "page_size", "in": "query", "schema": { - "$ref": "schemas.yaml#/PageSize" + "$ref": "#/components/schemas/PageSize" } }, { "name": "page_token", "in": "query", "schema": { - "$ref": "schemas.yaml#/PageToken" + "$ref": "#/components/schemas/PageToken" } } ], @@ -876,11 +876,11 @@ "factors": { "type": "array", "items": { - "$ref": "schemas.yaml#/Factor" + "$ref": "#/components/schemas/Factor" } }, "pagination": { - "$ref": "schemas.yaml#/PaginationMetadata" + "$ref": "#/components/schemas/PaginationMetadata" } } } @@ -898,7 +898,7 @@ "parameters": [ { "schema": { - "$ref": "schemas.yaml#/ServiceSID" + "$ref": "#/components/schemas/ServiceSID" }, "name": "service_sid", "in": "path", @@ -911,7 +911,7 @@ "content": { "application/json": { "schema": { - "$ref": "schemas.yaml#/Factor" + "$ref": "#/components/schemas/Factor" } } } @@ -921,7 +921,7 @@ "content": { "application/json": { "schema": { - "$ref": "schemas.yaml#/PasskeyFactorPublicKeyCredential" + "$ref": "#/components/schemas/PasskeyFactorPublicKeyCredential" } } } @@ -938,7 +938,7 @@ "name": "service_sid", "in": "path", "schema": { - "$ref": "schemas.yaml#/ServiceSID" + "$ref": "#/components/schemas/ServiceSID" }, "required": true }, @@ -946,7 +946,7 @@ "name": "factor_sid", "in": "path", "schema": { - "$ref": "schemas.yaml#/FactorSID" + "$ref": "#/components/schemas/FactorSID" }, "required": true } @@ -956,7 +956,7 @@ "content": { "application/json": { "schema": { - "$ref": "schemas.yaml#/Factor" + "$ref": "#/components/schemas/Factor" } } }, @@ -971,7 +971,7 @@ "parameters": [ { "schema": { - "$ref": "schemas.yaml#/ServiceSID" + "$ref": "#/components/schemas/ServiceSID" }, "name": "service_sid", "in": "path", @@ -979,7 +979,7 @@ }, { "schema": { - "$ref": "schemas.yaml#/FactorSID" + "$ref": "#/components/schemas/FactorSID" }, "name": "factor_sid", "in": "path", @@ -1001,7 +1001,7 @@ "parameters": [ { "schema": { - "$ref": "schemas.yaml#/ServiceSID" + "$ref": "#/components/schemas/ServiceSID" }, "name": "service_sid", "in": "path", @@ -1014,7 +1014,7 @@ "content": { "application/json": { "schema": { - "$ref": "schemas.yaml#/Challenge" + "$ref": "#/components/schemas/Challenge" } } } @@ -1029,10 +1029,10 @@ "description": "This operation creates Challenges.", "properties": { "factor_sid": { - "$ref": "schemas.yaml#/FactorSID" + "$ref": "#/components/schemas/FactorSID" }, "entity": { - "$ref": "schemas.yaml#/EntityIdentifier" + "$ref": "#/components/schemas/EntityIdentifier" }, "details": { "type": "object", @@ -1043,7 +1043,7 @@ "description": "The relying party identifier." }, "userVerification": { - "$ref": "schemas.yaml#/UserVerification" + "$ref": "#/components/schemas/UserVerification" } }, "required": [ @@ -1069,14 +1069,14 @@ "in": "path", "required": true, "schema": { - "$ref": "schemas.yaml#/ServiceSID" + "$ref": "#/components/schemas/ServiceSID" } }, { "name": "entity_sid", "in": "query", "schema": { - "$ref": "schemas.yaml#/EntitySID" + "$ref": "#/components/schemas/EntitySID" } }, { @@ -1090,14 +1090,14 @@ "name": "page_size", "in": "query", "schema": { - "$ref": "schemas.yaml#/PageSize" + "$ref": "#/components/schemas/PageSize" } }, { "name": "page_token", "in": "query", "schema": { - "$ref": "schemas.yaml#/PageToken" + "$ref": "#/components/schemas/PageToken" } } ], @@ -1112,11 +1112,11 @@ "challenges": { "type": "array", "items": { - "$ref": "schemas.yaml#/Challenge" + "$ref": "#/components/schemas/Challenge" } }, "pagination": { - "$ref": "schemas.yaml#/PaginationMetadata" + "$ref": "#/components/schemas/PaginationMetadata" } } } @@ -1134,7 +1134,7 @@ "parameters": [ { "schema": { - "$ref": "schemas.yaml#/ServiceSID" + "$ref": "#/components/schemas/ServiceSID" }, "name": "service_sid", "in": "path", @@ -1147,7 +1147,7 @@ "content": { "application/json": { "schema": { - "$ref": "schemas.yaml#/Challenge" + "$ref": "#/components/schemas/Challenge" } } } @@ -1157,7 +1157,7 @@ "content": { "application/json": { "schema": { - "$ref": "schemas.yaml#/ChallengePublicKeyCredential" + "$ref": "#/components/schemas/ChallengePublicKeyCredential" } } } @@ -1172,7 +1172,7 @@ "parameters": [ { "schema": { - "$ref": "schemas.yaml#/ServiceSID" + "$ref": "#/components/schemas/ServiceSID" }, "name": "service_sid", "in": "path", @@ -1180,7 +1180,7 @@ }, { "schema": { - "$ref": "schemas.yaml#/ChallengeSID" + "$ref": "#/components/schemas/ChallengeSID" }, "name": "challenge_sid", "in": "path", @@ -1192,7 +1192,7 @@ "content": { "application/json": { "schema": { - "$ref": "schemas.yaml#/Challenge" + "$ref": "#/components/schemas/Challenge" } } }, @@ -1207,7 +1207,7 @@ "parameters": [ { "schema": { - "$ref": "schemas.yaml#/ServiceSID" + "$ref": "#/components/schemas/ServiceSID" }, "name": "service_sid", "in": "path", @@ -1215,7 +1215,7 @@ }, { "schema": { - "$ref": "schemas.yaml#/ChallengeSID" + "$ref": "#/components/schemas/ChallengeSID" }, "name": "challenge_sid", "in": "path",