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

Documentation Issue anout API snapshot merge #1415

Open
benallard opened this issue Jan 6, 2025 · 5 comments · Fixed by aptly-dev/www.aptly.info#118
Open

Documentation Issue anout API snapshot merge #1415

benallard opened this issue Jan 6, 2025 · 5 comments · Fixed by aptly-dev/www.aptly.info#118
Assignees
Labels
please confirm resolved We believe the issue is resolved ! if so, please close the issue, thanks ;-)

Comments

@benallard
Copy link

The documentation about the API for snapshot merging is wrong.
it states that the destination should be a part of the body where it actually is in the URL.

Detailed Description

Update the docu regarding URL and Body requirement.

Context

The doc is currently misleading.

@benallard
Copy link
Author

The doc about snapshot pull is missing completely as well.

@neolynx
Copy link
Member

neolynx commented Jan 11, 2025

Hi, thanks for reporting !

we are currently updating the documentation on the web, and switching to swagger for the API documentation. To which one were you referring ? I believe swagger is up to date ...

@neolynx neolynx self-assigned this Jan 11, 2025
@benallard
Copy link
Author

benallard commented Jan 11, 2025 via email

@neolynx
Copy link
Member

neolynx commented Jan 11, 2025

The website will be updated in the next weeks...

until then you could try to serve swagger doc in your aptly by enabling it in aptly.conf (enable_swagger_endpoint: true): http://your-aptly-host/docs
or access swagger in the dev container with make docker-image docker-serve: http://localhost:3142/docs

@neolynx
Copy link
Member

neolynx commented Jan 27, 2025

See swagger doc: https://www.aptly.info/doc/api/swagger/

I hope this is correct now, please let us know !

@neolynx neolynx reopened this Jan 27, 2025
@neolynx neolynx added please confirm resolved We believe the issue is resolved ! if so, please close the issue, thanks ;-) and removed WIP labels Jan 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
please confirm resolved We believe the issue is resolved ! if so, please close the issue, thanks ;-)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants