{"id":17720149,"url":"https://github.com/gregschmit/rest-scaffold","last_synced_at":"2026-01-20T21:33:08.301Z","repository":{"id":57354941,"uuid":"194580084","full_name":"gregschmit/rest-scaffold","owner":"gregschmit","description":"A JavaScript/jQuery library that builds scaffolds (tables+actions) for objects exposed by a REST API.","archived":false,"fork":false,"pushed_at":"2024-12-13T20:37:01.000Z","size":357,"stargazers_count":1,"open_issues_count":10,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-08-27T23:59:59.807Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gregschmit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["gregschmit"],"custom":["https://www.paypal.me/schmitgreg"]}},"created_at":"2019-07-01T01:33:21.000Z","updated_at":"2021-01-03T23:52:45.000Z","dependencies_parsed_at":"2024-10-25T19:16:35.453Z","dependency_job_id":"656f42b2-fe02-40cb-9995-b4d42708c8f6","html_url":"https://github.com/gregschmit/rest-scaffold","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/gregschmit/rest-scaffold","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gregschmit%2Frest-scaffold","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gregschmit%2Frest-scaffold/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gregschmit%2Frest-scaffold/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gregschmit%2Frest-scaffold/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gregschmit","download_url":"https://codeload.github.com/gregschmit/rest-scaffold/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gregschmit%2Frest-scaffold/sbom","scorecard":{"id":445145,"data":{"date":"2025-08-11","repo":{"name":"github.com/gregschmit/rest-scaffold","commit":"8c495dc35b9fee58f742df623c5188eb558d9007"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/28 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-19T06:32:09.048Z","repository_id":57354941,"created_at":"2025-08-19T06:32:09.048Z","updated_at":"2025-08-19T06:32:09.048Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28614602,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T18:56:40.769Z","status":"ssl_error","status_checked_at":"2026-01-20T18:54:26.653Z","response_time":117,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-25T15:26:27.179Z","updated_at":"2026-01-20T21:33:08.284Z","avatar_url":"https://github.com/gregschmit.png","language":"JavaScript","funding_links":["https://github.com/sponsors/gregschmit","https://www.paypal.me/schmitgreg"],"categories":[],"sub_categories":[],"readme":"# REST-Scaffold.js\n\n![npm](https://img.shields.io/npm/v/rest-scaffold)\n\n`rest-scaffold.js` is a JavaScript library for building scaffolds (tables +\nactions) that represent objects which are exposed by a RESTful API.\n\n## How It Works\n\nThe basic idea is that you have some API at `https://example.com/api/thing` and\nyou provide a `div` with a `data-rest-scaffold` property which is a\nconfiguration in the form of a JSON, like:\n\n```json\n{\n  \"title\": \"Things\",\n  \"subtitle\": \"that go in the kitchen\",\n  \"recordTitle\": \"Thing\",\n  \"pkField\": \"id\",\n  \"url\": \"https://example.com/api/thing\",\n  \"csrfToken\": \"blahblah\"\n}\n```\n\nIf you're using a tool like\n[`django-rest-scaffolds`](https://github.com/gregschmit/django-rest-scaffold)\nto generate all this, then the tool can escape the quotes in the JSON.\nOtherwise, using single quotes for the property is helpful.\n\nThe `div` would look like this:\n\n```html\n\u003cdiv data-rest-scaffold='{\n  \"title\": \"Things\",\n  \"subtitle\": \"that go in the kitchen\",\n  \"recordTitle\": \"Thing\",\n  \"pkField\": \"id\",\n  \"url\": \"https://example.com/api/thing\",\n  \"csrfToken\": \"blahblah\"\n}'\u003e\u003c/div\u003e\n```\n\nThe library will assume the following endpoints exist:\n- `GET`-\u003e`thing` A listing of the objects\n- `POST`-\u003e`thing` A creation of a single object\n- `GET`-\u003e`thing/pk` A retrieval of a single object\n- `PUT`-\u003e`thing/pk` A update of a single object\n- `DELETE`-\u003e`thing/pk` A deletion of a single object\n\n## CDN Links\n\nhttps://cdn.jsdelivr.net/npm/rest-scaffold/dist/rest-scaffold.js\n\nhttps://cdn.jsdelivr.net/npm/rest-scaffold/dist/rest-scaffold.css\n\n## Configuration Options\n\n### Common Options\n\n`apiType` (string, default: `\"plain\"`) : This defines the structure of the API\nthat we are interacting with. `plain` indicates that a listing should return a\nJSON list with no pagination. If you use Django with the Rest Framework\npaginator, then you should put `django-paged`. This is a shortcut configuration\noption and the individual attributes that this affects can all be edited\nselectively.\n\n`title` (string, default: `\"\"`): The main bold text shown at the top of the\nscaffold.\n\n`subtitle` (string, default: `\"\"`): Lighter text shown after the title at the\ntop of the scaffold.\n\n`url` (string, default: `\"/\"`): The url that we should use to access the REST\nAPI.\n\n`csrfToken` (string, default: `\"\"`): Cross-Site Request Forgery token to use\nduring `POST`/`PUT` requests.\n\n`debug` (boolean, default: `true`): Whether debugging information (including\nrequest payload) should be displayed in scaffold error messages.\n\n`fields` (array, default: `[]`): The fields that we should expect. If this is\nfalsy, then the scaffold will try to infer them from a listing.\n\n`pkField` (string, default: `\"id\"`): The field that we can use as a primary\nkey.\n\n### Other Options\n\n`actionsLabel` (string, default: `\".\"`): The label for the actions column in\nthe scaffold.\n\n`csrfTokenHeader` (string, default: `\"X-CSRFToken\"`): The HTTP header for\npassing the CSRF Token.\n\n`isPaged` (boolean, default: `false`): Whether the API listing returns results\nin a paged format.\n\n`rawCreateForm` (string, default: `null`): The HTML create form.\n\n`rawUpdateForm` (string, default: `null`): The HTML update form.\n\n`recordTitle` (string, default: `\"Record\"`): The name for a single record.\n\n## Development\n\nTo build:\n\n    $ npm run-script build\n\nFor watch/compile for any changes:\n\n    $ npm run-script watch\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgregschmit%2Frest-scaffold","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgregschmit%2Frest-scaffold","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgregschmit%2Frest-scaffold/lists"}