{"id":18051741,"url":"https://github.com/apimatic/hosted-portal-workflow","last_synced_at":"2025-04-05T07:13:46.424Z","repository":{"id":46271945,"uuid":"399882830","full_name":"apimatic/hosted-portal-workflow","owner":"apimatic","description":null,"archived":false,"fork":false,"pushed_at":"2023-11-24T14:23:42.000Z","size":16,"stargazers_count":0,"open_issues_count":2,"forks_count":8,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-10T14:53:18.306Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"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/apimatic.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":"2021-08-25T16:15:38.000Z","updated_at":"2021-12-21T14:49:54.000Z","dependencies_parsed_at":"2024-12-18T12:42:21.643Z","dependency_job_id":"694809dc-2c55-4745-830d-cca00b725e7c","html_url":"https://github.com/apimatic/hosted-portal-workflow","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/apimatic%2Fhosted-portal-workflow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apimatic%2Fhosted-portal-workflow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apimatic%2Fhosted-portal-workflow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apimatic%2Fhosted-portal-workflow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apimatic","download_url":"https://codeload.github.com/apimatic/hosted-portal-workflow/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247299850,"owners_count":20916193,"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-10-30T22:55:32.106Z","updated_at":"2025-04-05T07:13:46.405Z","avatar_url":"https://github.com/apimatic.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"This repository demonstrates how APIMatic's API can be used to keep API Documentation and SDKs updated via CI/CD.\n\nThe [_main.yml_](https://github.com/apimatic/hosted-portal-workflow/blob/master/.github/workflows/main.yml) file contains a github workflow that updates the APIMatic portal when the respective API Specification is modified.\n\n\n## Prerequisites\n [Generate an API KEY](https://docs.apimatic.io/account-management/obtaining-auth-keys/) before proceeding.   \n    \n    \n   \n## Try it out\nFollow these steps to try out this workflow for yourself:\n\n\n1. Import an API into your APIMatic account.\n2. Get the API Entity ID for this newly imported API as described in [APIMatic's documentation.](https://docs.apimatic.io/manage-apis/get-api-keys/)\n4. Fork this repository.\n5. Create 2 new Github repository secrets in the forked repository:\n    - API_KEY to store your APIMatic API Key\n    - API_ENTITY_ID to store the API Entity ID you generated in step 2. \n6. In the \"inplace-import\" step of the /workflows/main.yml file, update the file name of your API Specification i.e 'file=@spec/\u003cyour spec name\u003e'.    \n6. Modify the API Specification stored in your repository and push your changes to the 'master' branch. This should trigger the CI/CD workflow. You can also manually trigger it via the 'Actions' tab in your repository.\n3. [Generate a portal](https://docs.apimatic.io/getting-started/creating-your-first-portal/) for the API that you imported in step 1 and preview the API Docs.\n7. The generated Portal should contain the changes you made to the API Specification.\n\n**The steps above do not include Portal publishing. If you want to automate the publishing step as well, uncomment the last workflow step in the _main.yml_ file. \nHowever, please note that the portal must be [published](https://docs.apimatic.io/publish-apis/hosting-your-portal/) manually at least once for the publish step in this workflow to run successfully.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapimatic%2Fhosted-portal-workflow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapimatic%2Fhosted-portal-workflow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapimatic%2Fhosted-portal-workflow/lists"}