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

Update API Documentation #6696

Closed
marcquark opened this issue Feb 7, 2019 · 10 comments
Closed

Update API Documentation #6696

marcquark opened this issue Feb 7, 2019 · 10 comments
Labels

Comments

@marcquark
Copy link
Contributor

Server (please complete the following information):

  • Snipe-IT Version 4.6.7
  • OS: Ubuntu
  • Web Server: Apache
  • PHP Version 7.0

Is your feature request related to a problem? Please describe.
I'm writing an (up-to-date) Python module for the Snipe-IT API and have noticed that documentation and implementation don't always match.

Describe the solution you'd like
Updated API Reference

Describe alternatives you've considered
Sifting through the code, i'm not always 100% sure what i'm doing is right.

Additional context
One missing feature i found was the /licenses/:id/seats endpoint. It's not here: https://snipe-it.readme.io/reference#licenses
But it's implemented here: https://github.com/snipe/snipe-it/blob/master/routes/api.php#L413 and it works.
I'm not familiar enough with Laravel nor the Snipe-IT project to confidently identify all API features

@stale
Copy link

stale bot commented Apr 8, 2019

Is this still relevant? We haven't heard from anyone in a bit. If so, please comment with any updates or additional detail.
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Don't take it personally, we just need to keep a handle on things. Thank you for your contributions!

@stale stale bot added the stale label Apr 8, 2019
@iainhallam
Copy link

If they don't match, is there a way that the documentation could be auto-generated from the API code?

@stale
Copy link

stale bot commented Apr 11, 2019

Okay, it looks like this issue or feature request might still be important. We'll re-open it for now. Thank you for letting us know!

@stale stale bot removed the stale label Apr 11, 2019
@stale
Copy link

stale bot commented Jun 10, 2019

Is this still relevant? We haven't heard from anyone in a bit. If so, please comment with any updates or additional detail.
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Don't take it personally, we just need to keep a handle on things. Thank you for your contributions!

@stale stale bot added the stale label Jun 10, 2019
@iainhallam
Copy link

Seats still not in the documentation.

@stale
Copy link

stale bot commented Jun 10, 2019

Okay, it looks like this issue or feature request might still be important. We'll re-open it for now. Thank you for letting us know!

@stale stale bot removed the stale label Jun 10, 2019
@stale
Copy link

stale bot commented Aug 9, 2019

Is this still relevant? We haven't heard from anyone in a bit. If so, please comment with any updates or additional detail.
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Don't take it personally, we just need to keep a handle on things. Thank you for your contributions!

@stale stale bot added the stale label Aug 9, 2019
@stale
Copy link

stale bot commented Aug 16, 2019

This issue has been automatically closed because it has not had recent activity. If you believe this is still an issue, please confirm that this issue is still happening in the most recent version of Snipe-IT and reply to this thread to re-open it.

@stale stale bot closed this as completed Aug 16, 2019
@marcquark
Copy link
Contributor Author

with #8058 merged, i'd like to reopen this one. i tried the "suggest edits" button on the api reference page but it didn't work. how/where is the API spec generated, and can it be influenced? if so, how? what's missing for this endpoint to make it into the API reference?

@marcquark
Copy link
Contributor Author

summoning @snipe since Mr. Stalebot doesn't seem to keep the promise of reopening on reply :-D
i saw you posted in a couple of other tickets recently that the readme.io doc is acting funny. the /licenses/:id/seats endpoint is missing, could you please check why that is? if any patching is needed, i'd need to be pointed into the right direction, then i could try fixing it and submit a PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants