From 492e7d6465c5dc2d30081ef95beb4f6c3841b3d4 Mon Sep 17 00:00:00 2001
From: Jens Utbult <jens.utbult@yubico.com>
Date: Wed, 21 Feb 2024 12:30:12 +0100
Subject: [PATCH] PIVSession documentation structure.

---
 .../Resources/PIVSessionExtension.md          | 61 +++++++++++++++++++
 .../Resources/SessionExtension.md             |  5 ++
 .../YubiKit/YubiKit.docc/Resources/YubiKit.md |  1 +
 3 files changed, 67 insertions(+)
 create mode 100644 YubiKit/YubiKit/YubiKit.docc/Resources/PIVSessionExtension.md

diff --git a/YubiKit/YubiKit/YubiKit.docc/Resources/PIVSessionExtension.md b/YubiKit/YubiKit/YubiKit.docc/Resources/PIVSessionExtension.md
new file mode 100644
index 0000000..de881db
--- /dev/null
+++ b/YubiKit/YubiKit/YubiKit.docc/Resources/PIVSessionExtension.md
@@ -0,0 +1,61 @@
+# ``YubiKit/PIVSession``
+
+@Metadata {
+    @DocumentationExtension(mergeBehavior: append)
+}
+
+## Topics
+
+### Managing the PIVSession
+
+- ``session(withConnection:)``
+- ``end()``
+- ``reset()``
+
+### Running commands in the PIV application
+
+- ``supports(_:)``
+- ``signWithKeyInSlot(_:keyType:algorithm:message:)``
+- ``decryptWithKeyInSlot(slot:algorithm:encrypted:)``
+- ``calculateSecretKeyInSlot(slot:peerPublicKey:)``
+- ``attestKeyInSlot(slot:)``
+- ``generateKeyInSlot(slot:type:pinPolicy:touchPolicy:)``
+- ``putKey(key:inSlot:pinPolicy:touchPolicy:)``
+- ``putCertificate(certificate:inSlot:compress:)``
+- ``getCertificateInSlot(_:)``
+- ``deleteCertificateInSlot(slot:)``
+- ``setManagementKey(_:type:requiresTouch:)``
+- ``authenticateWith(managementKey:keyType:)``
+- ``getSlotMetadata(_:)``
+- ``getManagementKeyMetadata()``
+- ``reset()``
+- ``getSerialNumber()``
+- ``verifyPin(_:)``
+- ``setPin(_:oldPin:)``
+- ``setPuk(_:oldPuk:)``
+- ``unblockPinWithPuk(_:newPin:)``
+- ``getPinMetadata()``
+- ``getPukMetadata()``
+- ``getPinAttempts()``
+- ``set(pinAttempts:pukAttempts:)``
+- ``blockPin(counter:)``
+- ``blockPuk(counter:)``
+
+
+
+### Return types
+
+- ``PIVTouchPolicy``
+- ``PIVPinPolicy``
+- ``PIVSlot``
+- ``PIVKeyType``
+- ``PIVVerifyPinResult``
+- ``PIVManagementKeyMetadata``
+- ``PIVSlotMetadata``
+- ``PIVPinPukMetadata``
+- ``PIVManagementKeyType``
+
+### Errors
+
+- ``PIVSessionError``
+
diff --git a/YubiKit/YubiKit/YubiKit.docc/Resources/SessionExtension.md b/YubiKit/YubiKit/YubiKit.docc/Resources/SessionExtension.md
index f2f67fe..d247991 100644
--- a/YubiKit/YubiKit/YubiKit.docc/Resources/SessionExtension.md
+++ b/YubiKit/YubiKit/YubiKit.docc/Resources/SessionExtension.md
@@ -14,6 +14,11 @@
 
 - ``end()``
 
+### Session feature support
+
+- ``SessionFeature``
+- ``supports(_:)``
+
 ### Errors
 
 - ``SessionError``
diff --git a/YubiKit/YubiKit/YubiKit.docc/Resources/YubiKit.md b/YubiKit/YubiKit/YubiKit.docc/Resources/YubiKit.md
index bbac198..99204b2 100755
--- a/YubiKit/YubiKit/YubiKit.docc/Resources/YubiKit.md
+++ b/YubiKit/YubiKit/YubiKit.docc/Resources/YubiKit.md
@@ -67,3 +67,4 @@ communication with the YubiKey.
 - ``Session``
 - ``OATHSession``
 - ``ManagementSession``
+- ``PIVSession``