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

API docs: Machines resource updates #1175

Merged
merged 7 commits into from
Nov 16, 2023
Merged

API docs: Machines resource updates #1175

merged 7 commits into from
Nov 16, 2023

Conversation

andie787
Copy link
Contributor

@andie787 andie787 commented Nov 14, 2023

Summary of changes

Take some Machines API content (from @ tqbf) and meld it into the existing Operations on Machines section of the api docs. Including:

  • update some response examples
  • add some intro content
  • add missing params
  • add endpoints for all sections

Plus:

  • create some tables for some parameters/properties
  • compare both docs and specs and add missing params and descriptions
  • add some example requests

Todo:

  • search and fill in all "todo"s that I added
  • add types and defaults
  • add speed info?
  • add error codes

Related Fly.io community and GitHub links

n/a if none

Notes

n/a if none

Preview

https://aa-docs.fly.dev/docs/machines/working-with-machines/

@andie787 andie787 marked this pull request as ready for review November 16, 2023 21:02
@andie787 andie787 merged commit a159885 into main Nov 16, 2023
3 checks passed
@andie787 andie787 deleted the update-api branch November 16, 2023 22:12
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.

2 participants