Update app/templates/docs.html

app/templates/docs.html

@@ -5,21 +5,22 @@
 <h2 class="mb-4">📘 Resume Ranker API Documentation</h2>
 
 <h4>🔗 Endpoint</h4>
-<pre><code class="copyable">POST https://yourdomain.com/api/rank-resumes</code></pre>
+<pre><code class="copyable">POST https://rankapply-api.hf.space/rank-resumes</code></pre>
 
 <h4>🔐 Authentication</h4>
 <p>Include your API key in the <code>Authorization</code> header:</p>
-<pre><code class="copyable">Authorization: Bearer amn=your_api_key_here</code></pre>
+<pre><code class="copyable">Authorization: Bearer your_api_key_here</code></pre>
+<p class="text-muted"><small>Never share your API key publicly. Treat it like a password.</small></p>
 
-<h4>📤 Request Parameters</h4>
+<h4>Request Parameters</h4>
 <ul>
   <li><strong>resumes</strong> (file[], required): One or more PDF resumes</li>
   <li><strong>job_description</strong> (text, required): The job description to match against</li>
 </ul>
 
-<h4>📥 Example Request (curl)</h4>
-<pre><code class="copyable">curl -X POST https://yourdomain.com/api/rank-resumes \
-  -H "Authorization: Bearer amn=your_api_key_here" \
+<h4>📥 Example Request (cURL)</h4>
+<pre><code class="copyable">curl -X POST https://rankapply-api.hf.space/rank-resumes \
+  -H "Authorization: Bearer your_api_key_here" \
   -F "resumes=@cv1.pdf" \
   -F "resumes=@cv2.pdf" \
   -F "job_description=We are hiring a backend engineer..."</code></pre>
@@ -28,7 +29,7 @@
 <pre><code class="copyable">import requests
 
 headers = {
-    "Authorization": "Bearer amn=your_api_key_here"
+    "Authorization": "Bearer your_api_key_here"
 }
 files = [
     ('resumes', ('cv1.pdf', open('cv1.pdf', 'rb'), 'application/pdf')),
@@ -38,12 +39,13 @@ data = {
     "job_description": "We are hiring a backend engineer..."
 }
 
-response = requests.post("https://yourdomain.com/api/rank-resumes", headers=headers, files=files, data=data)
+response = requests.post("https://rankapply-api.hf.space/rank-resumes", headers=headers, files=files, data=data)
 print(response.json())</code></pre>
 
-<h4>📦 Sample Response</h4>
+<h4> Sample Response</h4>
 <pre><code class="copyable">{
-  "results": [
+  "job_description": "We are hiring a backend engineer...",
+  "ranked_resumes": [
     {
       "filename": "cv2.pdf",
       "score": 0.8745
@@ -52,18 +54,17 @@ print(response.json())</code></pre>
       "filename": "cv1.pdf",
       "score": 0.6721
     }
-  ],
-  "count": 2,
-  "requested_by": "user@example.com"
+  ]
 }</code></pre>
 
 <hr class="my-5">
 
-<h4>🧪 Try It Now</h4>
+<h4> Try It Now</h4>
 <form method="POST" action="{{ url_for('auth.try_api') }}" enctype="multipart/form-data">
   <div class="mb-3">
     <label for="api_key" class="form-label">API Key</label>
-    <input type="text" class="form-control" id="api_key" name="api_key" placeholder="amn=your_api_key_here" required>
+    <input type="text" class="form-control" id="api_key" name="api_key"
+           placeholder="your_api_key_here" required>
   </div>
   <div class="mb-3">
     <label for="resumes" class="form-label">Upload Resumes (PDF)</label>
@@ -76,39 +77,38 @@ print(response.json())</code></pre>
   <button type="submit" class="btn btn-success">Submit Test Request</button>
 </form>
 
-{% if response is iterable and response[0] is mapping %}
+{% if response and response.ranked_resumes %}
 <hr class="my-5">
-<h5>📬 API Response</h5>
+<h5> Ranked Results</h5>
 <table class="table table-striped">
   <thead>
     <tr><th>Filename</th><th>Score</th></tr>
   </thead>
   <tbody>
-    {% for item in response %}
+    {% for item in response.ranked_resumes %}
     <tr>
       <td>{{ item.filename }}</td>
-      <td>{{ item.score }}</td>
+      <td>{{ "%.4f"|format(item.score) }}</td>
     </tr>
     {% endfor %}
   </tbody>
 </table>
 {% elif response %}
 <hr class="my-5">
-<h5>📬 API Response</h5>
-<pre><code>{{ response }}</code></pre>
+<h5> API Response</h5>
+<pre><code>{{ response | tojson(indent=2) }}</code></pre>
 {% endif %}
 
 <p class="mt-4"><a href="{{ url_for('auth.dashboard') }}" class="btn btn-secondary">← Back to Dashboard</a></p>
 
-<!-- ✅ Copy Button Script -->
+<!--  Copy Button Script -->
 <script>
 document.querySelectorAll('code.copyable').forEach(block => {
   const button = document.createElement('button');
   button.innerText = 'Copy';
   button.className = 'btn btn-sm btn-outline-primary mb-2 float-end';
   button.addEventListener('click', () => {
-    const text = block.innerText;
-    navigator.clipboard.writeText(text);
+    navigator.clipboard.writeText(block.innerText);
     button.innerText = 'Copied!';
     setTimeout(() => button.innerText = 'Copy', 1500);
   });