Merge pull request #40 from ayushshrivastv/feature/organize-examples

OpenAPI spec - requiring non mandatory field

Author: ayushshrivastv

.github/workflows/pages.yml

@@ -27,57 +27,10 @@ jobs:
       - name: Setup Pages
         uses: actions/configure-pages@v5
 
-      - name: Prepare public directory
-        run: |
-          # Create public directory
-          mkdir -p public
-          
-          # Copy documentation files
-          cp -r docs/* public/
-          
-          # Copy sample files into the samples directory
-          mkdir -p public/samples
-          cp -r DocsExample public/samples/
-          cp api.yaml public/samples/
-          cp -r API.docc public/samples/
-          
-          # Create README with instructions and note about source
-          cat > public/samples/README.md << 'EOF'
-          # The DocsExample directory within the repository (ayushshrivastv/OpenAPI-integration-with-DocC/DocsExample) is the source for this example.
-
-          ## Building and Viewing Documentation Locally
-
-          1. Convert OpenAPI specification to SymbolGraph:
-             ```
-             swift run openapi-to-symbolgraph api.yaml --output-path api.symbolgraph.json
-             ```
-
-          2. Generate DocC documentation:
-             ```
-             xcrun docc convert API.docc --fallback-display-name API --fallback-bundle-identifier com.example.API --fallback-bundle-version 1.0.0 --additional-symbol-graph-dir ./ --output-path ./docs
-             ```
-
-          3. View the documentation locally:
-             ```
-             python -m http.server 8000 --directory docs
-             ```
-
-          4. Open your browser to http://localhost:8000
-          EOF
-          
-          # Copy the existing index.html as is, since it already has the correct paths
-          cp index.html public/
-          
-          # Copy other necessary files
-          cp favicon.ico public/ || true
-          cp favicon.svg public/ || true
-          cp .nojekyll public/ || true
-          cp 404.html public/ || true
-      
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: './public'
+          path: './docs'
 
       - name: Deploy to GitHub Pages
         id: deployment

Examples/PetStoreAPI/PetStore.docc/PetStore.md

@@ -0,0 +1,7 @@
+# PetStore
+
+Swagger Pet Store API documentation.
+
+## Overview
+
+This documentation provides details about the Pet Store API endpoints and schemas, generated from the OpenAPI specification. 

Examples/PetStoreAPI/PetStore.doccarchive/css/866.2d08a543.css

@@ -0,0 +1 @@
+{"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"text":"Swagger Pet Store API documentation.","type":"text"}],"primaryContentSections":[{"content":[{"type":"heading","level":2,"anchor":"Overview","text":"Overview"},{"inlineContent":[{"type":"text","text":"This documentation provides details about the Pet Store API endpoints and schemas, generated from the OpenAPI specification."}],"type":"paragraph"}],"kind":"content"}],"sections":[],"identifier":{"url":"doc:\/\/PetStore\/documentation\/PetStore","interfaceLanguage":"swift"},"kind":"article","hierarchy":{"paths":[[]]},"metadata":{"role":"collection","title":"PetStore"}}