Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ADD Doc API keys endpoints to documentation #383

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

hexaltation
Copy link
Collaborator

@hexaltation hexaltation commented Aug 13, 2024

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

More explicit supported python versions

more explicit grist-checkout -> grist-core-checkout
: in array can be misinterpreted by some yaml parsers. Split enum in many line makes it easy
Copy link

netlify bot commented Aug 13, 2024

Deploy Preview for grist-help-preview failed.

Name Link
🔨 Latest commit 8c1f6c2
🔍 Latest deploy log https://app.netlify.com/sites/grist-help-preview/deploys/66bb5a802964400008e43e50

2 similar comments
Copy link

netlify bot commented Aug 13, 2024

Deploy Preview for grist-help-preview failed.

Name Link
🔨 Latest commit 8c1f6c2
🔍 Latest deploy log https://app.netlify.com/sites/grist-help-preview/deploys/66bb5a802964400008e43e50

Copy link

netlify bot commented Aug 13, 2024

Deploy Preview for grist-help-preview failed.

Name Link
🔨 Latest commit 8c1f6c2
🔍 Latest deploy log https://app.netlify.com/sites/grist-help-preview/deploys/66bb5a802964400008e43e50

@fflorent
Copy link
Collaborator

Fixes gristlabs/grist-core#579

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

@hexaltation
Copy link
Collaborator Author

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
Copy link
Member

dsagal commented Aug 13, 2024

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 gristlabs/grist-core#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.

@hexaltation hexaltation changed the title Doc api keys ADD Doc API keys enpoints to help Aug 14, 2024
@hexaltation hexaltation changed the title ADD Doc API keys enpoints to help ADD Doc API keys enpoints to documentation Aug 14, 2024
@hexaltation hexaltation changed the title ADD Doc API keys enpoints to documentation ADD Doc API keys endpoints to documentation Aug 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants