{"id":21194789,"url":"https://github.com/advanced-rest-client/api-endpoint-documentation","last_synced_at":"2026-01-12T11:49:52.103Z","repository":{"id":32459021,"uuid":"129462808","full_name":"advanced-rest-client/api-endpoint-documentation","owner":"advanced-rest-client","description":"⛔️ DEPRECATED This component is being deprecated. Use `api-documentation` instead.","archived":false,"fork":false,"pushed_at":"2023-01-07T09:06:26.000Z","size":8980,"stargazers_count":1,"open_issues_count":3,"forks_count":3,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-04-14T21:18:36.989Z","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}},"created_at":"2018-04-13T23:15:11.000Z","updated_at":"2024-05-03T18:40:07.874Z","dependencies_parsed_at":"2023-01-14T21:17:33.239Z","dependency_job_id":null,"html_url":"https://github.com/advanced-rest-client/api-endpoint-documentation","commit_stats":null,"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/advanced-rest-client%2Fapi-endpoint-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/advanced-rest-client%2Fapi-endpoint-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/advanced-rest-client%2Fapi-endpoint-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/advanced-rest-client%2Fapi-endpoint-documentation/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-endpoint-documentation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225616859,"owners_count":17497229,"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:25.116Z","updated_at":"2026-01-12T11:49:52.097Z","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 [amf-components](https://github.com/advanced-rest-client/amf-components) module. This module will be archived when [PR 1](https://github.com/advanced-rest-client/amf-components/pull/1) is merged.\n\n-----\n\nA component to generate documentation for an API resource from AMF model.\n\n[![Tests and publishing](https://github.com/advanced-rest-client/api-endpoint-documentation/actions/workflows/deployment.yml/badge.svg)](https://github.com/advanced-rest-client/api-endpoint-documentation/actions/workflows/deployment.yml)\n\n[![Published on NPM](https://img.shields.io/npm/v/@api-components/api-endpoint-documentation.svg)](https://www.npmjs.com/package/@api-components/api-endpoint-documentation)\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## Styling\n\n`\u003capi-endpoint-documentation\u003e` provides the following custom properties and mixins for styling:\n\nCustom property | Description | Default\n----------------|-------------|----------\n`--arc-font-headline-color` | Color of the method title | ``\n`--arc-font-headline-font-size` | Font size of the method title | ``\n`--arc-font-headline-letter-spacing` | Letter spacing of the method title | ``\n`--arc-font-headline-line-height` | Line height of the method title | ``\n`--arc-font-headline-narrow-font-size` | Font size of the method title in mobile-friendly view | ``\n`--arc-font-title-color` | Color of the overview section title | ``\n`--arc-font-title-font-size` | Font size of the overview section title | ``\n`--arc-font-title-line-height` | Line height of the overview section title | ``\n`--arc-font-title-narrow-font-size` | Font size of the overview section title in mobile-friendly view | ``\n`--arc-font-subhead-color` | Color of the collapsible section title | ``\n`--arc-font-subhead-font-size` | Font size of the collapsible section title | ``\n`--arc-font-subhead-line-height` | Line height of the collapsible section title | ``\n`--arc-font-subhead-narrow-font-size` | Font size of the collapsible section title in mobile-friendly view | ``\n`--api-endpoint-documentation-description-color` |  | `rgba(0, 0, 0, 0.74)`\n`--api-endpoint-documentation-bottom-navigation-color` |  | `#000`\n`--api-endpoint-documentation-method-doc-border-top-color` |  | `#E5E5E5`\n`--api-endpoint-documentation-method-doc-border-top-style` |  | `dashed`\n`--api-endpoint-documentation-tryit-width` |  | `40%`\n`--api-endpoint-documentation-tryit-max-width` |  | ``\n`--api-endpoint-documentation-tryit-background-color` |  | `#ECEFF1`\n`--api-endpoint-documentation-tryit-panels-background-color` |  | `#fff`\n`--api-endpoint-documentation-tryit-panels-border-radius` |  | `3px`\n`--api-endpoint-documentation-tryit-panels-border-color` |  | `#EEEEEE`\n`--api-endpoint-documentation-tryit-panels-border-style` |  | `solid`\n`--api-endpoint-documentation-tryit-title-border-bottom-color` |  | `#bac6cb`\n`--api-endpoint-documentation-tryit-title-border-bottom-style` |  | `solid`\n`--no-info-message-font-style` |  | `italic`\n`--no-info-message-font-size` |  | `16px`\n`--no-info-message-color` |  | `rgba(0, 0, 0, 0.74)`\n\n## Usage\n\n### Installation\n\n```sh\nnpm install --save @api-components/api-endpoint-documentation\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-endpoint-documentation/api-endpoint-documentation.js';\n    \u003c/script\u003e\n  \u003c/head\u003e\n  \u003cbody\u003e\n    \u003capi-endpoint-documentation amf=\"...\" endpoint=\"...\"\u003e\u003c/api-endpoint-documentation\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-endpoint-documentation/api-endpoint-documentation.js';\n\nclass SampleElement extends PolymerElement {\n  render() {\n    return html`\n    \u003capi-endpoint-documentation\n      .amf=\"${this.amf}\"\n      .endpoint=\"${this.endpoint}\"\n      .method=\"${this.method}\"\n      .previous=\"${this.previous}\"\n      .next=\"${this.next}\"\n      ?narrow=\"${this.narrow}\"\n      ?legacy=\"${this.legacy}\"\n      ?outlined=\"${this.outlined}\"\n      .inlineMethods=\"${inlineMethods}\"\n      .scrollTarget=\"${scrollTarget}\"\n      .noTryIt=\"${this.noTryit}\"\n      @tryit-requested=\"${this._tryitHandler}\"\u003e\u003c/api-endpoint-documentation\u003e\n    `;\n  }\n\n  _tryitHandler(e) {\n    console.log('opening api-request-panel...');\n  }\n}\ncustomElements.define('sample-element', SampleElement);\n```\n\n## Development\n\n```sh\ngit clone https://github.com/advanced-rest-client/api-endpoint-documentation\ncd api-endpoint-documentation\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\n## Breaking Changes in v3\n\nWhen using `inlineMethods` property you should note this breaking changes.\n\n### OAuth popup location\n\nThe `bower-location` attribute becomes `auth-popup-location`.\nIt is a path to `node_modules` directory. It can be both relative or absolute location. For example `/static/console/node_modules` will produce OAuth Redirect URI `/static/console/node_modules/@advanced-rest-client/oauth-authorization/oauth-popup.html`.\n\nHowever, you are encourage to use your own redirect popup. It can be anything but it must post message to the opened window with URL parameters. See `@advanced-rest-client/oauth-authorization/oauth-popup.html` for more details.\n\n### Code Mirror dependencies\n\nCode mirror is not ES6 ready. Their build contains AMD exports which is incompatible with native modules. Therefore the dependencies cannot be imported with the element but outside of it.\nThe component requires the following scripts to be ready before it's initialized (especially body and headers editors):\n\n```html\n\u003cscript src=\"node_modules/jsonlint/lib/jsonlint.js\"\u003e\u003c/script\u003e\n\u003cscript src=\"node_modules/codemirror/lib/codemirror.js\"\u003e\u003c/script\u003e\n\u003cscript src=\"node_modules/codemirror/addon/mode/loadmode.js\"\u003e\u003c/script\u003e\n\u003cscript src=\"node_modules/codemirror/mode/meta.js\"\u003e\u003c/script\u003e\n\u003c!-- Some basic syntax highlighting --\u003e\n\u003cscript src=\"node_modules/codemirror/mode/javascript/javascript.js\"\u003e\u003c/script\u003e\n\u003cscript src=\"node_modules/codemirror/mode/xml/xml.js\"\u003e\u003c/script\u003e\n\u003cscript src=\"node_modules/codemirror/mode/htmlmixed/htmlmixed.js\"\u003e\u003c/script\u003e\n\u003cscript src=\"node_modules/codemirror/addon/lint/lint.js\"\u003e\u003c/script\u003e\n\u003cscript src=\"node_modules/codemirror/addon/lint/json-lint.js\"\u003e\u003c/script\u003e\n```\n\nCodeMirror's modes location. May be skipped if all possible modes are already included into the app.\n\n```html\n\u003cscript\u003e\n/* global CodeMirror */\nCodeMirror.modeURL = 'node_modules/codemirror/mode/%N/%N.js';\n\u003c/script\u003e\n```\n\n### Dependencies for OAuth1 and Digest authorization methods\n\nFor the same reasons as for CodeMirror this dependencies are required for OAuth1 and Digest authorization panels to work.\n\n```html\n\u003cscript src=\"node_modules/cryptojslib/components/core.js\"\u003e\u003c/script\u003e\n\u003cscript src=\"node_modules/cryptojslib/rollups/sha1.js\"\u003e\u003c/script\u003e\n\u003cscript src=\"node_modules/cryptojslib/components/enc-base64-min.js\"\u003e\u003c/script\u003e\n\u003cscript src=\"node_modules/cryptojslib/rollups/md5.js\"\u003e\u003c/script\u003e\n\u003cscript src=\"node_modules/cryptojslib/rollups/hmac-sha1.js\"\u003e\u003c/script\u003e\n\u003cscript src=\"node_modules/jsrsasign/lib/jsrsasign-rsa-min.js\"\u003e\u003c/script\u003e\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadvanced-rest-client%2Fapi-endpoint-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadvanced-rest-client%2Fapi-endpoint-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadvanced-rest-client%2Fapi-endpoint-documentation/lists"}