Skip to content

Commit d4d5e09

Browse files
committed
Add more files_editability info to README.md
1 parent bb72160 commit d4d5e09

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -222,10 +222,11 @@ There are two components to each request:
222222

223223
2. `requested_data`: An array of strings representing the types of repository metrics desired for each repository. Currently, the following are implemented for Wikifactory projects:
224224
1. `files_info`: The numbers and proportions of mechanical and electronic computer-assisted design (CAD), image, data, document, and other file types in the repository.
225-
2. `license`: The license for the repository.
226-
3. `tags`: Aggregated tags for the repository and any associated with the maintainers of that repsitory.
227-
4. `commits_level`: The hash identifier (contribution `id` for Wikifactory projects) and timestamp of each commit to the repository. This can be used to graph the commit activity level in a frontend visualisation.
228-
5. `issues_level`: Similar to `commits_level`, but for all issues in the repository.
225+
2. `files_editability`: Basic information about how "editable" the CAD files are in this repository.
226+
3. `license`: The license for the repository.
227+
4. `tags`: Aggregated tags for the repository and any associated with the maintainers of that repsitory.
228+
5. `commits_level`: The hash identifier (contribution `id` for Wikifactory projects) and timestamp of each commit to the repository. This can be used to graph the commit activity level in a frontend visualisation.
229+
6. `issues_level`: Similar to `commits_level`, but for all issues in the repository.
229230

230231
The following is an example request that could be sent to the API for three Wikifactory projects:
231232

@@ -236,8 +237,9 @@ The following is an example request that could be sent to the API for three Wiki
236237
"https://wikifactory.com/@luzleanne/community-composter",
237238
"https://wikifactory.com/+elektricworks/pikon-telescope"
238239
],
239-
"requested_data": [
240+
"requested_data": [
240241
"files_info",
242+
"files_editability",
241243
"license",
242244
"tags",
243245
"commits_level",

0 commit comments

Comments
 (0)