{"id":21194720,"url":"https://github.com/advanced-rest-client/api-responses-document","last_synced_at":"2025-06-23T18:37:21.608Z","repository":{"id":32458852,"uuid":"129320993","full_name":"advanced-rest-client/api-responses-document","owner":"advanced-rest-client","description":"⛔️ DEPRECATED This component is being deprecated. Use `api-documentation` instead.","archived":false,"fork":false,"pushed_at":"2023-03-04T04:35:21.000Z","size":1694,"stargazers_count":0,"open_issues_count":12,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-31T16:51:32.403Z","etag":null,"topics":["deprecated","obsolete"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/advanced-rest-client.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2018-04-12T23:11:20.000Z","updated_at":"2021-09-30T07:56:39.000Z","dependencies_parsed_at":"2024-11-07T04:38:34.475Z","dependency_job_id":"ff219c7a-13e9-476e-b032-d6feba1f9108","html_url":"https://github.com/advanced-rest-client/api-responses-document","commit_stats":{"total_commits":92,"total_committers":6,"mean_commits":"15.333333333333334","dds":0.3586956521739131,"last_synced_commit":"297b5b1c2868000392955b8d93a6fef7ab507121"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/advanced-rest-client%2Fapi-responses-document","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/advanced-rest-client%2Fapi-responses-document/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/advanced-rest-client%2Fapi-responses-document/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/advanced-rest-client%2Fapi-responses-document/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/advanced-rest-client","download_url":"https://codeload.github.com/advanced-rest-client/api-responses-document/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/advanced-rest-client%2Fapi-responses-document/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259210550,"owners_count":22822339,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["deprecated","obsolete"],"created_at":"2024-11-20T19:24:04.522Z","updated_at":"2025-06-23T18:37:21.572Z","avatar_url":"https://github.com/advanced-rest-client.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DEPRECATED\n\nThis component is being deprecated. The code base has been moved to [api-documentation](https://github.com/advanced-rest-client/api-documentation) module. This module will be archived when [PR 37](https://github.com/advanced-rest-client/api-documentation/pull/37) is merged.\n\n-----\n\nA documentation for HTTP method responses based on AMF model.\n\n[![Published on NPM](https://img.shields.io/npm/v/@api-components/api-responses-document.svg)](https://www.npmjs.com/package/@api-components/api-responses-document)\n\n[![Tests and publishing](https://github.com/advanced-rest-client/api-responses-document/actions/workflows/deployment.yml/badge.svg)](https://github.com/advanced-rest-client/api-responses-document/actions/workflows/deployment.yml)\n\n## Version compatibility\n\nThis version only works with AMF model version 2 (AMF parser \u003e= 4.0.0).\nFor compatibility with previous model version use `3.x.x` version of the component.\n\n## Usage\n\n### Installation\n\n```sh\nnpm install --save @api-components/api-responses-document\n```\n\n### In an html file\n\n```html\n\u003chtml\u003e\n  \u003chead\u003e\n    \u003cscript type=\"module\"\u003e\n      import '@api-components/api-responses-document/api-responses-document.js';\n    \u003c/script\u003e\n  \u003c/head\u003e\n  \u003cbody\u003e\n    \u003capi-responses-document\u003e\u003c/api-responses-document\u003e\n\n    \u003cscript\u003e\n    const model = await getAmfModel();\n    const returns = await getMethodReturns(model);\n    const doc = document.querySelector('api-responses-document');\n    doc.amf = model;\n    doc.returns = returns;\n    // Select a 400 response from auto generated list of available status codes\n    const index = doc.codes.indexOf(400);\n    doc.selected = index;\n    \u003c/script\u003e\n  \u003c/body\u003e\n\u003c/html\u003e\n```\n\n### In a LitElement\n\n```js\nimport { LitElement, html } from 'lit-element';\nimport '@api-components/api-responses-document/api-responses-document.js';\n\nclass SampleElement extends PolymerElement {\n  render() {\n    return html`\n    \u003capi-responses-document .amf=\"${this.amf}\" returns=\"...\"\u003e\u003c/api-responses-document\u003e\n    `;\n  }\n}\ncustomElements.define('sample-element', SampleElement);\n```\n\n### In a Polymer 3 element\n\n```js\nimport {PolymerElement, html} from '@polymer/polymer';\nimport '@api-components/api-responses-document/api-responses-document.js';\n\nclass SampleElement extends PolymerElement {\n  static get template() {\n    return html`\n    \u003capi-responses-document\u003e\u003c/api-responses-document\u003e\n    `;\n  }\n}\ncustomElements.define('sample-element', SampleElement);\n```\n\n## Development\n\n```sh\ngit clone https://github.com/api-components/api-responses-document\ncd api-responses-document\nnpm install\n```\n\n### Running the demo locally\n\n```sh\nnpm start\n```\n\n### Running the tests\n\n```sh\nnpm test\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadvanced-rest-client%2Fapi-responses-document","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadvanced-rest-client%2Fapi-responses-document","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadvanced-rest-client%2Fapi-responses-document/lists"}