broadfield-dev commited on
Commit
f723f6c
·
verified ·
1 Parent(s): e8dee07

Update assembler_docs.py

Browse files
Files changed (1) hide show
  1. assembler_docs.py +5 -5
assembler_docs.py CHANGED
@@ -1,4 +1,4 @@
1
- DOCUMENTATION="""# Assembler Space API Documentation
2
 
3
  ## Overview
4
  The **Assembler Space** is a Hugging Face Space that acts as a factory for creating new Hugging Face Spaces dynamically. It exposes a Flask-based API that accepts JSON input containing code, files, parameters, and configuration details. Upon receiving a valid request, it creates a new Space repository on Hugging Face, populates it with the provided files, and triggers its deployment. The API supports multiple Space types (e.g., `gradio`, `static`, `docker`, `streamlit`) and multi-file submissions, making it versatile for generating a wide range of applications.
@@ -42,7 +42,7 @@ Creates a new Hugging Face Space based on the provided JSON payload.
42
  | Field | Type | Description |
43
  |-----------|--------|-----------------------------------------------------------------------------|
44
  | `message` | String | A brief status message (e.g., `"New Space created"`). |
45
- | `url` | String | The URL of the newly created Space (e.g., `https://huggingface.co/spaces/<username>/<space-name>`). |
46
  | `note` | String | Additional information (e.g., deployment time warning). |
47
  | `error` | String | (Only in error responses) Description of what went wrong. |
48
 
@@ -80,7 +80,7 @@ Returns this documentation as plain text in Markdown format.
80
  ~~~json
81
  {
82
  "message": "New Space created",
83
- "url": "https://huggingface.co/spaces/broadfield-dev/GeneratedSpace-abc123",
84
  "note": "It may take a few minutes to build and deploy."
85
  }
86
  ~~~
@@ -108,7 +108,7 @@ Returns this documentation as plain text in Markdown format.
108
  ~~~json
109
  {
110
  "message": "New Space created",
111
- "url": "https://huggingface.co/spaces/broadfield-dev/GeneratedSpace-xyz789",
112
  "note": "It may take a few minutes to build and deploy."
113
  }
114
  ~~~
@@ -134,7 +134,7 @@ Returns this documentation as plain text in Markdown format.
134
  ~~~json
135
  {
136
  "message": "New Space created",
137
- "url": "https://huggingface.co/spaces/broadfield-dev/GeneratedSpace-def456",
138
  "note": "It may take a few minutes to build and deploy."
139
  }
140
  ~~~
 
1
+ DOCUMENTATION = """# Assembler Space API Documentation
2
 
3
  ## Overview
4
  The **Assembler Space** is a Hugging Face Space that acts as a factory for creating new Hugging Face Spaces dynamically. It exposes a Flask-based API that accepts JSON input containing code, files, parameters, and configuration details. Upon receiving a valid request, it creates a new Space repository on Hugging Face, populates it with the provided files, and triggers its deployment. The API supports multiple Space types (e.g., `gradio`, `static`, `docker`, `streamlit`) and multi-file submissions, making it versatile for generating a wide range of applications.
 
42
  | Field | Type | Description |
43
  |-----------|--------|-----------------------------------------------------------------------------|
44
  | `message` | String | A brief status message (e.g., `"New Space created"`). |
45
+ | `url` | String | The URL of the newly created Space (e.g., `https://huggingface.co/spaces/Space-Share/<space-name>`). |
46
  | `note` | String | Additional information (e.g., deployment time warning). |
47
  | `error` | String | (Only in error responses) Description of what went wrong. |
48
 
 
80
  ~~~json
81
  {
82
  "message": "New Space created",
83
+ "url": "https://huggingface.co/spaces/Space-Share/GeneratedSpace-abc123",
84
  "note": "It may take a few minutes to build and deploy."
85
  }
86
  ~~~
 
108
  ~~~json
109
  {
110
  "message": "New Space created",
111
+ "url": "https://huggingface.co/spaces/Space-Share/GeneratedSpace-xyz789",
112
  "note": "It may take a few minutes to build and deploy."
113
  }
114
  ~~~
 
134
  ~~~json
135
  {
136
  "message": "New Space created",
137
+ "url": "https://huggingface.co/spaces/Space-Share/GeneratedSpace-def456",
138
  "note": "It may take a few minutes to build and deploy."
139
  }
140
  ~~~