Add API Docs (#758)

* Update SPI info

* Update CI

* Update API Docs workflow

* Add DocC bundle

* Wrap exports

* Fix the imports

* Expand index

* Address PR review comments

* Exports check is now in the reusable workflow

.github/workflows/api-docs.yml

@@ -1,18 +1,14 @@
 name: deploy-api-docs
 on:
-   push:
-     branches:
-       - main
+  push:
+    branches:
+      - main
 
 jobs:
-  deploy:
-    name: api.vapor.codes
-    runs-on: ubuntu-latest
-    steps:
-    - name: Deploy api-docs
-      uses: appleboy/ssh-action@master
-      with:
-        host: vapor.codes
-        username: vapor
-        key: ${{ secrets.VAPOR_CODES_SSH_KEY }}
-        script: ./github-actions/deploy-api-docs.sh
+  build-and-deploy:
+     uses: vapor/api-docs/.github/workflows/build-and-deploy-docs-workflow.yml@main
+     secrets: inherit
+     with:
+       package_name: fluent
+       modules: Fluent
+       pathsToInvalidate: /fluent

.github/workflows/test.yml

@@ -10,3 +10,4 @@ jobs:
        with_coverage: true
        with_tsan: true
        with_public_api_check: ${{ github.event_name == 'pull_request' }}
+

.spi.yml

@@ -1,3 +1,5 @@
 version: 1
 metadata:
-  authors: “Maintained by the Vapor Core Team with hundreds of contributions from the Vapor Community.”
+  authors: "Maintained by the Vapor Core Team with hundreds of contributions from the Vapor Community."
+external_links:
+  documentation: "https://docs.vapor.codes/fluent/overview/"

Sources/Fluent/Concurrency/ModelCredentialsAuthenticatable+Concurrency.swift

@@ -1,6 +1,7 @@
 #if compiler(>=5.5) && canImport(_Concurrency)
 import NIOCore
 import Vapor
+import FluentKit
 
 @available(macOS 12, iOS 15, watchOS 8, tvOS 15, *)
 extension ModelCredentialsAuthenticatable {

Sources/Fluent/Concurrency/Pagination+Concurrency.swift

@@ -1,6 +1,7 @@
 #if compiler(>=5.5) && canImport(_Concurrency)
 import NIOCore
 import Vapor
+import FluentKit
 
 @available(macOS 12, iOS 15, watchOS 8, tvOS 15, *)
 extension QueryBuilder {

Sources/Fluent/Concurrency/Sessions+Concurrency.swift

@@ -1,6 +1,7 @@
 #if compiler(>=5.5) && canImport(_Concurrency)
 import NIOCore
 import Vapor
+import FluentKit
 
 @available(macOS 12, iOS 15, watchOS 8, tvOS 15, *)
 extension Model where Self: SessionAuthenticatable, Self.SessionID == Self.IDValue {

Sources/Fluent/Docs.docc/index.md

@@ -0,0 +1,5 @@
+# ``Fluent``
+
+Fluent makes it easy for you to use FluentKit in your Vapor application. It ties together the FluentKit database abstraction layer with the Vapor application lifecycle. It also provides helpers for mapping FluentKit's models to Vapor's authentication APIs.
+
+For more information, see the [Vapor documentation](https://docs.vapor.codes/fluent/overview/).

Sources/Fluent/Exports.swift

@@ -1,7 +1,11 @@
+#if !BUILDING_DOCC
+
 @_exported import FluentKit
 
 infix operator ~~
 infix operator =~
 infix operator !~
 infix operator !=~
 infix operator !~=
+
+#endif

Sources/Fluent/Fluent+Cache.swift

@@ -1,4 +1,5 @@
 import Vapor
+import FluentKit
 
 extension Application.Caches {
     public var fluent: Cache {

Sources/Fluent/Fluent+Paginate.swift

@@ -1,4 +1,5 @@
 import Vapor
+import FluentKit
 
 extension QueryBuilder {
     public func paginate(

Sources/Fluent/Fluent+Sessions.swift

@@ -1,4 +1,5 @@
 import Vapor
+import FluentKit
 
 extension Application.Fluent {
     public var sessions: Sessions {

Sources/Fluent/ModelAuthenticatable.swift

@@ -1,4 +1,5 @@
 import Vapor
+import FluentKit
 
 public protocol ModelAuthenticatable: Model, Authenticatable {
     static var usernameKey: KeyPath<Self, Field<String>> { get }

Sources/Fluent/ModelCredentialsAuthenticatable.swift

@@ -1,4 +1,5 @@
 import Vapor
+import FluentKit
 
 public protocol ModelCredentialsAuthenticatable: Model, Authenticatable {
     static var usernameKey: KeyPath<Self, Field<String>> { get }

Sources/Fluent/ModelTokenAuthenticatable.swift

@@ -1,4 +1,5 @@
 import Vapor
+import FluentKit
 
 public protocol ModelTokenAuthenticatable: Model, Authenticatable {
     associatedtype User: Model & Authenticatable

Tests/FluentTests/CredentialTests.swift

@@ -2,6 +2,7 @@ import XCTFluent
 import XCTVapor
 import Fluent
 import Vapor
+import FluentKit
 
 final class CredentialTests: XCTestCase {
 

Tests/FluentTests/OperatorTests.swift

@@ -1,6 +1,7 @@
 import Fluent
 import Vapor
 import XCTVapor
+import FluentKit
 
 final class OperatorTests: XCTestCase {
     func testCustomOperators() throws {

Tests/FluentTests/PaginationTests.swift

@@ -2,6 +2,7 @@ import Fluent
 import Vapor
 import XCTVapor
 import XCTFluent
+import FluentKit
 
 final class PaginationTests: XCTestCase {
     func testPagination() throws {

Tests/FluentTests/QueryHistoryTests.swift

@@ -2,6 +2,7 @@ import Fluent
 import Vapor
 import XCTFluent
 import XCTVapor
+import FluentKit
 
 final class QueryHistoryTests: XCTestCase {
     func testQueryHistoryDisabled() throws {

Tests/FluentTests/RepositoryTests.swift

@@ -2,6 +2,7 @@ import Fluent
 import Vapor
 import XCTFluent
 import XCTVapor
+import FluentKit
 
 final class RepositoryTests: XCTestCase {
     func testRepositoryPatternStatic() throws {

Tests/FluentTests/SessionTests.swift

@@ -2,6 +2,7 @@ import XCTFluent
 import XCTVapor
 import Fluent
 import Vapor
+import FluentKit
 
 final class SessionTests: XCTestCase {
     func testSessionMigrationName() {