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

Refactor Catalog API #589

Open
mikekistler opened this issue Oct 25, 2024 · 1 comment · May be fixed by #659
Open

Refactor Catalog API #589

mikekistler opened this issue Oct 25, 2024 · 1 comment · May be fixed by #659
Assignees

Comments

@mikekistler
Copy link
Contributor

The Catalog API should be refactored to comply with standard HTTP/REST conventions. Specifically:

  • The PUT operation to update a catalog item should take the item id in the path
  • The GET operations on
    • /api/catalog/items/by/{name}
    • /api/catalog/items/type/{typeId}/brand/{brandId}
    • /api/catalog/items/type/all/brand/{brandId}
  • should be dropped and replaced with optional query parameters name, type, and brand on the GET on /api/catalog/items
  • The "text" parameter of GET on /api/catalog/items/withsemanticrelevance/{text} should be changed from a path parameter to a query parameter
@mikekistler mikekistler self-assigned this Nov 27, 2024
@mikekistler
Copy link
Contributor Author

I've started work on this but want to get the OpenAPI support (#631, #632) merged in ahead of it.

@mikekistler mikekistler linked a pull request Dec 13, 2024 that will close this issue
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 a pull request may close this issue.

1 participant