search

gristlabs / grist-help

Grist documentation and help center articles
https://support.getgrist.com
Other
13 stars 17 forks source link

ADD Doc API keys endpoints to documentation #383

Open hexaltation opened 1 month ago

hexaltation commented 1 month ago

Must be merge at the same time than gristlabs/grist-core#1115 for the new API endpoints can be accessible via console API.

Related to gristlabs/grist-core#579

netlify[bot] commented 1 month ago

Deploy Preview for grist-help-preview failed.

Name Link
Latest commit 8c1f6c2e69a45716957cdd6a5b8afdd52f85b45c
Latest deploy log https://app.netlify.com/sites/grist-help-preview/deploys/66bb5a802964400008e43e50
netlify[bot] commented 1 month ago

Deploy Preview for grist-help-preview failed.

Name Link
Latest commit 8c1f6c2e69a45716957cdd6a5b8afdd52f85b45c
Latest deploy log https://app.netlify.com/sites/grist-help-preview/deploys/66bb5a802964400008e43e50
netlify[bot] commented 1 month ago

Deploy Preview for grist-help-preview failed.

Name Link
Latest commit 8c1f6c2e69a45716957cdd6a5b8afdd52f85b45c
Latest deploy log https://app.netlify.com/sites/grist-help-preview/deploys/66bb5a802964400008e43e50
fflorent commented 1 month ago

Fixes https://github.com/gristlabs/grist-core/issues/579

Wait, will it really fix this issue? Using this syntax will close as completed the above issue.

hexaltation commented 1 month ago

Fixes gristlabs/grist-core#579

Wait, will it really fix this issue? Using this syntax will close as completed the above issue.

I'm ok that it's not perfect but I want to keep track the fact that this PR needs to be merge at the same time as the functional one.

/api/grist.yml is much code than doc to me, as it's functionally used in production by console api to interact with the app.

Can't it be better to move it to gristlabs/grist-core and to pull it when doc is built ?

@gristlabs people do you have an opinion over this ?

dsagal commented 1 month ago

I agree with @fflorent that the comment on the PR seems risky -- not sure it would actually close the issue in the other repo. Anyway, it would be helpful to have a clearer title and description for the PR, perhaps like "Add OpenAPI spec for the new Doc API keys endpoints in https://github.com/gristlabs/grist-core/issues/579"?

I also agree with @hexaltation suggestion to move /api/grist.yml into grist-core! Good idea! It would make it easier to keep grist.yml up-to-date. It would also help keep the API Console in sync with the current version of Grist.