{"id":13498589,"url":"https://podcastindex-org.github.io/docs-api/","last_synced_at":"2025-03-29T01:32:08.336Z","repository":{"id":39641307,"uuid":"289691346","full_name":"Podcastindex-org/docs-api","owner":"Podcastindex-org","description":"Developer documentation for the podcastindex.org api.","archived":false,"fork":false,"pushed_at":"2025-02-05T06:59:57.000Z","size":1069,"stargazers_count":58,"open_issues_count":35,"forks_count":31,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-02-05T07:31:07.915Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://podcastindex-org.github.io/docs-api/","language":null,"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/Podcastindex-org.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":"2020-08-23T13:26:55.000Z","updated_at":"2025-02-05T07:00:01.000Z","dependencies_parsed_at":"2023-02-12T20:15:36.793Z","dependency_job_id":"232e3f00-b2fc-4600-91f3-aa7ffab8d5d5","html_url":"https://github.com/Podcastindex-org/docs-api","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/Podcastindex-org%2Fdocs-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Podcastindex-org%2Fdocs-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Podcastindex-org%2Fdocs-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Podcastindex-org%2Fdocs-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Podcastindex-org","download_url":"https://codeload.github.com/Podcastindex-org/docs-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246125959,"owners_count":20727498,"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-07-31T21:00:37.321Z","updated_at":"2025-03-29T01:32:07.920Z","avatar_url":"https://github.com/Podcastindex-org.png","language":null,"funding_links":[],"categories":["Index","Anhang A: Programmier-Ressourcen"],"sub_categories":["Podcasts","Allgemeine Ressourcen"],"readme":"# Live Data\n\nSee the live docs at https://podcastindex-org.github.io/docs-api/\n\n# Introduction\n\nThis project contains the files for describing the PodcastIndex.org API using the\n[openapi](https://www.openapis.org/) syntax.\n\nThe `redocly/cli` Node package is used to compile the separate files in to a single master file.\nThis master file can be used in many [tools](https://openapi.tools/).\n\nThe [RapiDoc](https://mrin9.github.io/RapiDoc/) software is used to generate the document webpage.\n\n# Installation\n\nNo items are installed globally. Run `yarn` to install the Node required packages.\n\nNOTE: required yarn 2.x or newer. See https://yarnpkg.com/getting-started/install for install instructions.\n\n# Available Scripts\n\nIn the project directory, you can run:\n\n## `yarn preview`\n\nStarts the redoc preview server.\nOpen [http://localhost:8080](http://localhost:8080) to view it in the browser.\n\n## `yarn build`\n\nRuns `bundle_json`, `bundle_yaml`\n\n## `yarn bundle_json`\n\nGenerates the master openapi file `pi_api.json` in the `docs` folder.\n\nThe `pi_api.json` and `pi_api.yaml` contain the same content just shown in different formats.\n\n## `yarn bundle_yaml`\n\nGenerates the master openapi file `pi_api.yaml` in the `docs` folder.\n\nThe `pi_api.json` and `pi_api.yaml` contain the same content just shown in different formats.\n\n## `yarn lint`\n\nRun the redoc linter on the source yaml files.\n\n## `yarn reload`\n\nStarts a LiveReload file watcher.\n\nInstall a compatible [browser extension](http://livereload.com/) and connect it to the livereload instance.\n\nPages connected to the file watcher will reload 2 seconds after the file changes. The 2 second delay gives the\nopenapi preview script time to generate the new api files.\n\n## `yarn server`\n\nCreate a simple server in the `docs` folder to serve the release files.\n\n# Folder Structure\n\n## `api_src`\n\nThis folder contains the source yaml files for describing the API. The root file is `root.yaml`.\n\nSee the [openapi Specification](https://www.openapis.org/) for details on the format. Additional specification details\nfrom [Swagger](https://swagger.io/specification/) and\n[OpenAPI GitHub](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/).\n\nTHe remaining folders follow the structure suggested by\n[create-openapi-repo](https://github.com/Redocly/create-openapi-repo).\n\n### `paths`\n\nThe folder structure should follow the paths in the API requests where the file is the last value in the request URL\npath.\n\nSee additional suggestions for the structure from redoc in the\n[create-openapi-repo project](https://github.com/Redocly/create-openapi-repo/blob/master/template/openapi/paths/README.md).\n\n### `components`\n\nIn general, a folder exists for each object type in the API yaml document. A block that is used in many files should\nhave a separate yaml file created and be referenced from the files where it is used.\n\n- `callbacks` - reusable [Callback Objects](http://spec.openapis.org/oas/v3.1.0#callback-object)\n- `examples` - reusable [Example Objects](http://spec.openapis.org/oas/v3.1.0#example-object)\n- `headers` - reusable [Header Objects](http://spec.openapis.org/oas/v3.1.0#header-object)\n- `links` - reusable [Link Objects](http://spec.openapis.org/oas/v3.1.0#link-object)\n- `parameters` - reusable [Parameter Objects](http://spec.openapis.org/oas/v3.1.0#parameter-object)\n- `requestBodies` - reusable [Request Body Objects](http://spec.openapis.org/oas/v3.1.0#request-body-object)\n- `responses` - reusable [Response Objects](http://spec.openapis.org/oas/v3.1.0#responses-object)\n- `schemas` - reusable [Schema Objects](http://spec.openapis.org/oas/v3.1.0#schema-object)\n- `securitySchemes` - reusable [Security Scheme Objects](http://spec.openapis.org/oas/v3.1.0#security-scheme-object)\n\n## `docs`\n\nSource directory for site source files. This folder should be deployed to the server.\n\nThe master api files and images are in the root directory.\nThe root `index.html` uses the [RapiDoc](https://mrin9.github.io/RapiDoc/) UI.\n\nThe `template.html` file is the necessary template file for the [redoc](https://redoc.ly/redoc/) preview generated with\n`yarn preview` is also in this folder.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/podcastindex-org.github.io%2Fdocs-api%2F","html_url":"https://awesome.ecosyste.ms/projects/podcastindex-org.github.io%2Fdocs-api%2F","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/podcastindex-org.github.io%2Fdocs-api%2F/lists"}