Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ npm run generate-provider -- \
--config-path provider-dev/config/all_services.csv \
--servers='[{"url":"https://api.github.com"}]' \
--provider-config='{"auth":{"type":"basic","username_var":"STACKQL_GITHUB_USERNAME","password_var":"STACKQL_GITHUB_PASSWORD"}}' \
--naive-req-body-translate \
--overwrite
```

Expand Down Expand Up @@ -218,13 +219,27 @@ const providerTitle = "GitHub Provider";
c. Then generate docs using...

```bash
rm -rf website/docs/*
npm run generate-docs -- \
--provider-name github \
--provider-dir ./provider-dev/openapi/src/github/v00.00.00000 \
--output-dir ./website \
--provider-data-dir ./provider-dev/docgen/provider-data
```

```bash
find website/docs/services -type f -name "*.md" -exec sed -i -E 's#\]\(/(rest/|developers/|actions/|code-security/|github/)#](https://docs.github.com/\1#g' {} +
```

```bash
find website/docs/services -type f -name "*.md" -exec sed -i 's|(#set-github-actions-permissions-for-a-repository)|(https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)|g; s|(#set-github-actions-permissions-for-an-organization)|(https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)|g' {} +
```

```bash
find website/docs/services -type f -name "*.md" -exec sed -i 's|(#create-a-self-hosted-runner-group-for-an-organization)|(https://docs.github.com/en/actions/how-tos/manage-runners/self-hosted-runners/manage-access)|g' {} +
```


## 8. Test web docs locally

```bash
Expand Down
1,601 changes: 761 additions & 840 deletions provider-dev/config/all_services.csv

Large diffs are not rendered by default.

29 changes: 29 additions & 0 deletions provider-dev/openapi/src/github/v00.00.00000/services/actions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15389,6 +15389,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.runners
create_hosted_runner_for_org:
config:
requestBodyTranslate:
Expand Down Expand Up @@ -15449,6 +15450,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.images
get_custom_image_for_org:
operation:
$ref: >-
Expand Down Expand Up @@ -15487,6 +15489,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.image_versions
get_custom_image_version_for_org:
operation:
$ref: >-
Expand Down Expand Up @@ -15788,6 +15791,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.repositories
set_selected_repositories_enabled_github_actions_organization:
config:
requestBodyTranslate:
Expand Down Expand Up @@ -15920,6 +15924,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.repositories
set_selected_repositories_self_hosted_runners_organization:
config:
requestBodyTranslate:
Expand Down Expand Up @@ -16020,6 +16025,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.runner_groups
create_self_hosted_runner_group_for_org:
config:
requestBodyTranslate:
Expand Down Expand Up @@ -16081,6 +16087,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.runners
sqlVerbs:
select:
- $ref: >-
Expand All @@ -16101,6 +16108,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.repositories
set_repo_access_to_self_hosted_runner_group_in_org:
config:
requestBodyTranslate:
Expand Down Expand Up @@ -16151,6 +16159,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.runners
set_self_hosted_runners_in_group_for_org:
config:
requestBodyTranslate:
Expand Down Expand Up @@ -16200,6 +16209,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.runners
get_self_hosted_runner_for_org:
operation:
$ref: '#/paths/~1orgs~1{org}~1actions~1runners~1{runner_id}/get'
Expand All @@ -16218,6 +16228,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.runners
get_self_hosted_runner_for_repo:
operation:
$ref: >-
Expand Down Expand Up @@ -16378,6 +16389,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.labels
add_custom_labels_to_self_hosted_runner_for_org:
config:
requestBodyTranslate:
Expand Down Expand Up @@ -16417,6 +16429,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.labels
add_custom_labels_to_self_hosted_runner_for_repo:
config:
requestBodyTranslate:
Expand Down Expand Up @@ -16488,6 +16501,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.secrets
get_org_secret:
operation:
$ref: '#/paths/~1orgs~1{org}~1actions~1secrets~1{secret_name}/get'
Expand Down Expand Up @@ -16515,6 +16529,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.secrets
get_repo_secret:
operation:
$ref: >-
Expand Down Expand Up @@ -16546,6 +16561,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.secrets
get_environment_secret:
operation:
$ref: >-
Expand Down Expand Up @@ -16643,6 +16659,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.repositories
set_selected_repos_for_org_secret:
config:
requestBodyTranslate:
Expand Down Expand Up @@ -16692,6 +16709,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.variables
create_org_variable:
config:
requestBodyTranslate:
Expand Down Expand Up @@ -16728,6 +16746,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.variables
create_repo_variable:
config:
requestBodyTranslate:
Expand Down Expand Up @@ -16766,6 +16785,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.variables
create_environment_variable:
config:
requestBodyTranslate:
Expand Down Expand Up @@ -16848,6 +16868,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.repositories
set_selected_repos_for_org_variable:
config:
requestBodyTranslate:
Expand Down Expand Up @@ -16897,6 +16918,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.artifacts
get_artifact:
operation:
$ref: >-
Expand All @@ -16918,6 +16940,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.artifacts
sqlVerbs:
select:
- $ref: '#/components/x-stackQL-resources/artifacts/methods/get_artifact'
Expand Down Expand Up @@ -16984,13 +17007,15 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.jobs
list_jobs_for_workflow_run:
operation:
$ref: >-
#/paths/~1repos~1{owner}~1{repo}~1actions~1runs~1{run_id}~1jobs/get
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.jobs
sqlVerbs:
select:
- $ref: >-
Expand Down Expand Up @@ -17102,6 +17127,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.workflow_runs
sqlVerbs:
select:
- $ref: >-
Expand Down Expand Up @@ -17164,6 +17190,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.secrets
sqlVerbs:
select:
- $ref: >-
Expand All @@ -17184,6 +17211,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.variables
sqlVerbs:
select:
- $ref: >-
Expand Down Expand Up @@ -17387,6 +17415,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.workflows
get_workflow:
operation:
$ref: >-
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2623,6 +2623,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.tasks
create_task:
config:
requestBodyTranslate:
Expand Down Expand Up @@ -2661,6 +2662,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.tasks
get_task_by_id:
operation:
$ref: '#/paths/~1agents~1tasks~1{task_id}/get'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7472,12 +7472,14 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.repositories
list_installation_repos_for_authenticated_user:
operation:
$ref: '#/paths/~1user~1installations~1{installation_id}~1repositories/get'
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.repositories
add_repo_to_installation_for_authenticated_user:
operation:
$ref: >-
Expand Down Expand Up @@ -7523,6 +7525,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.installations
sqlVerbs:
select:
- $ref: >-
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4005,12 +4005,14 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.check_runs
list_for_ref:
operation:
$ref: '#/paths/~1repos~1{owner}~1{repo}~1commits~1{ref}~1check-runs/get'
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.check_runs
sqlVerbs:
select:
- $ref: '#/components/x-stackQL-resources/runs/methods/get'
Expand Down Expand Up @@ -4085,6 +4087,7 @@ components:
response:
mediaType: application/json
openAPIDocKey: '200'
objectKey: $.check_suites
sqlVerbs:
select:
- $ref: '#/components/x-stackQL-resources/suites/methods/get_suite'
Expand Down
Loading
Loading