{"id":22606697,"url":"https://github.com/benjaminmedia/bonnier-services-documentation","last_synced_at":"2025-03-28T22:15:26.964Z","repository":{"id":140156436,"uuid":"73368432","full_name":"BenjaminMedia/bonnier-services-documentation","owner":"BenjaminMedia","description":"This repo contains the OpenAPI spec for Bonner Services","archived":false,"fork":false,"pushed_at":"2018-02-08T10:24:01.000Z","size":1014,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-26T14:54:35.111Z","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/BenjaminMedia.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2016-11-10T09:49:27.000Z","updated_at":"2016-11-10T09:50:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"07924625-0fcd-4b2b-a28b-da27bf005964","html_url":"https://github.com/BenjaminMedia/bonnier-services-documentation","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BenjaminMedia%2Fbonnier-services-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BenjaminMedia%2Fbonnier-services-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BenjaminMedia%2Fbonnier-services-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BenjaminMedia%2Fbonnier-services-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BenjaminMedia","download_url":"https://codeload.github.com/BenjaminMedia/bonnier-services-documentation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246106689,"owners_count":20724401,"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":[],"created_at":"2024-12-08T14:14:40.029Z","updated_at":"2025-03-28T22:15:26.950Z","avatar_url":"https://github.com/BenjaminMedia.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# IndexSearch OpenAPI Specification\n[![Build Status](https://travis-ci.org/BenjaminMedia/bonnier-services-documentation.svg?branch=master)](https://travis-ci.org/BenjaminMedia/bonnier-services-documentation)\n\n## Steps to finish\n\n1. Enable [Travis](https://docs.travis-ci.com/user/getting-started/#To-get-started-with-Travis-CI%3A) for your repository (**note**: you already have `.travis.yml` file)\n2. [Create GitHub access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/); check `public_repo` on `Select scopes` section.\n3. Use the token value as a value for [Travis environment variable](https://docs.travis-ci.com/user/environment-variables/#Defining-Variables-in-Repository-Settings) with the name `GH_TOKEN`\n4. Make a test commit to trigger CI: `git commit --allow-empty -m \"Test Travis CI\" \u0026\u0026 git push`\n5. Wait until Travis build is finished. You can check progress by clicking on the `Build Status` badge at the top\n6. If you did everything correct, https://benjaminmedia.github.io/bonnier-services-documentation/ will lead to your new docs\n7. **[Optional]** You can setup [custom domain](https://help.github.com/articles/using-a-custom-domain-with-github-pages/) (just create `web/CNAME` file)\n8. Start writing/editing your OpenAPI spec: check out [usage](#usage) section below\n9. **[Optional]** If you document public API consider adding it into [APIs.guru](https://APIs.guru) directory using [this form](https://apis.guru/add-api/).\n10. Delete this section :smile:\n\n## Links\n\n- Documentation(ReDoc): https://benjaminmedia.github.io/bonnier-services-documentation/\n- SwaggerUI: https://benjaminmedia.github.io/bonnier-services-documentation/swagger-ui/\n- Look full spec:\n    + JSON https://benjaminmedia.github.io/bonnier-services-documentation/swagger.json\n    + YAML https://benjaminmedia.github.io/bonnier-services-documentation/swagger.yaml\n- Preview spec version for branch `[branch]`: https://benjaminmedia.github.io/bonnier-services-documentation/preview/[branch]\n\n**Warning:** All above links are updated only after Travis CI finishes deployment\n\n## Working on specification\n### Install\n\n1. Install [Node JS](https://nodejs.org/)\n2. Clone repo and `cd`\n    + Run `npm install`\n\n### Usage\n\n1. Run `npm start`\n2. Checkout console output to see where local server is started. You can use all [links](#links) (except `preview`) by replacing https://benjaminmedia.github.io/bonnier-services-documentation/ with url from the message: `Server started \u003curl\u003e`\n3. Make changes using your favorite editor or `swagger-editor` (look for URL in console output)\n4. All changes are immediately propagated to your local server, moreover all documentation pages will be automagically refreshed in a browser after each change\n**TIP:** you can open `swagger-editor`, documentation and `swagger-ui` in parallel\n5. Once you finish with the changes you can run tests using: `npm test`\n6. Share you changes with the rest of the world by pushing to GitHub :smile:\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenjaminmedia%2Fbonnier-services-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbenjaminmedia%2Fbonnier-services-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenjaminmedia%2Fbonnier-services-documentation/lists"}