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

[DEV] Update documentation to describe how data is parsed with /Inventory/RedfishEndpoints #18

Open
3 tasks
davidallendj opened this issue Mar 28, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@davidallendj
Copy link
Collaborator

There is currently no SMD documentation that mentions how inventory data can be included in the HTTP request JSON body to populate certain data structures. The documentation should be updated to describe how to submit data in the request, how it gets parsed (at least to some degree), and what objects get created and inserted into the database. Having good documentation here will likely be very important later on if we decided to expand the parsing capabilities to create more structures specifically using the data from tools like magellan.

  • Describe the HTTP request JSON structure
  • Describe the parsing process in some detail
  • Describe what is being created and inserted
@davidallendj davidallendj added the documentation Improvements or additions to documentation label Mar 28, 2024
@davidallendj davidallendj self-assigned this Mar 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant