Skip to content

Commit bb72160

Browse files
committed
Document files_editability API request
1 parent d34849c commit bb72160

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,16 @@ Specifically, for each repository, the response will include:
255255
* `repository`: String containing the repository URL.
256256
* `platform`: String, only `Wikifactory` for now.
257257
* `requested_data`: Object containing the following:
258+
* `files_editability`: Object containing the following:
259+
* `files_count`: Integer number of (presumed to be) CAD files that are not text documents or data files (like CSV).
260+
* `files_openness`: Object containing the following:
261+
* `open`: Integer number of files using open formats.
262+
* `closed`: Integer number of files using closed/proprietary formats.
263+
* `other`: Integer number of files not categorised in either of the above.
264+
* `files_encoding`: Object containing the following:
265+
* `binary`: Integer number of files using binary formats.
266+
* `text`: Integer number of files using text-based formats.
267+
* `other`: Integer number of files not categorised in either of the above.
258268
* `files_info`: Object containing the following:
259269
* `total_files`: Integer of total number of files in the repository.
260270
* `ecad_files`: Integer number of electronic CAD files.
@@ -309,6 +319,7 @@ Specifically, for each repository, the response will include:
309319

310320
Notes:
311321

322+
* For `files_editability` above, filetypes are identified by file extensions. The categories and mapping are documented in [`oshminer/filetypes.py`](./oshminer/filetypes.py), and can be traced the [`osh-file-types` list](https://gitlab.com/OSEGermany/osh-file-types/) by Open Source Ecology Germany.
312323
* For `files_info` above, filetypes are identified by file extensions. The categories and mapping are located in [`oshminer/filetypes.py`](./oshminer/filetypes.py).
313324
* The `license` information and formatting is largely based on that from the GitHub-managed [choosealicense.com repository](https://github.com/github/choosealicense.com), with the exception of some open source hardware licenses which were manually added.
314325

0 commit comments

Comments
 (0)