Updating DataStore API definition to consider ResourcesAPI structure #2368
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
danielbdias
force-pushed
the
update/open-api-definitions-with-datastore
branch
2 times, most recently
from
2fe2c15
to
23d6d0c
Compare
danielbdias
commented
Apr 12, 2023
api/openapi.yaml
Outdated
| @@ -1429,10 +1429,10 @@ paths: | |||
| description: "problem deleting a demo" | |||
|
|
|||
| # Data Stores | |||
| /datastores: | |||
| /datastore: | |||
There was a problem hiding this comment.
Today on the Resources Manager engine, we only deal with resources in the singular form on the endpoints.
There was a problem hiding this comment.
so if we add a plural form, it would leave the api almost unchanged, right? it's not hard to add that to the resource manager, do you think that would work?
There was a problem hiding this comment.
It makes sense. I'm finishing the first draft of the DataStore, and I'll add this functionality.
There was a problem hiding this comment.
Issue created: #2387
danielbdias
commented
Apr 12, 2023
| @@ -1449,17 +1449,12 @@ paths: | |||
| schema: | |||
| type: integer | |||
| default: 0 | |||
| - in: query | |||
There was a problem hiding this comment.
Right now, we are not explicitly putting a query parameter on our endpoints because they are injected as it is on the queries, making our endpoints unsafe. Later we need to improve this.
There was a problem hiding this comment.
IMO we should put it here and fix the implementation
There was a problem hiding this comment.
Agreed. We can open a PR to solve that.
There was a problem hiding this comment.
Issue created: #2388
danielbdias
force-pushed
the
update/open-api-definitions-with-datastore
branch
from
78a3589
to
9997297
Compare
|
Is there anything to 'show' out of this via a Loom video? |
danielbdias
force-pushed
the
update/open-api-definitions-with-datastore
branch
2 times, most recently
from
9f7ac8a
to
62adde3
Compare
|
@kdhamric it is possible! I've updated the PR description with a Loom video. |
Fixing sorting fields on OpenAPI Updating OpenAPI to consider DataStore endpoint managing only one record Add endpoint in plural
danielbdias
force-pushed
the
update/open-api-definitions-with-datastore
branch
from
62adde3
to
07e8bc5
Compare
xoscar
approved these changes
Apr 17, 2023
danielbdias
added a commit
that referenced
this pull request
Apr 17, 2023
…2368) Fixing sorting fields on OpenAPI Updating OpenAPI to consider DataStore endpoint managing only one record Add endpoint in plural
danielbdias
added a commit
that referenced
this pull request
Apr 19, 2023
…2368) Fixing sorting fields on OpenAPI Updating OpenAPI to consider DataStore endpoint managing only one record Add endpoint in plural
danielbdias
added a commit
that referenced
this pull request
Apr 20, 2023
…2368) Fixing sorting fields on OpenAPI Updating OpenAPI to consider DataStore endpoint managing only one record Add endpoint in plural
danielbdias
added a commit
that referenced
this pull request
Apr 21, 2023
…2368) Fixing sorting fields on OpenAPI Updating OpenAPI to consider DataStore endpoint managing only one record Add endpoint in plural
xoscar
added a commit
that referenced
this pull request
Apr 25, 2023
* Updating DataStore API definition to consider ResourcesAPI structure (#2368) Fixing sorting fields on OpenAPI Updating OpenAPI to consider DataStore endpoint managing only one record Add endpoint in plural * Adding datastoreresource package * Update internal references to use datastoreresource package * Isolate database resources on each test * Adding behavior for no datastore scenario * Fixing rebase problems * Fixing another rebase problem * Updating DataStore API definition to consider ResourcesAPI structure (#2368) Fixing sorting fields on OpenAPI Updating OpenAPI to consider DataStore endpoint managing only one record Add endpoint in plural * Fixing merge * Adding documentation for delete operation * Improving cleanup code * Updating datastore API * Adding CLI generated code * wip * wip * Fixing CLI * deprecated old commands * Adding wrongly deleted file * simplifying the resource actions creation steps --------- Co-authored-by: Oscar Reyes <oscar-rreyes1@hotmail.com>
xoscar
added a commit
that referenced
this pull request
Apr 26, 2023
… CLI commands (#2414) * Updating DataStore API definition to consider ResourcesAPI structure (#2368) Fixing sorting fields on OpenAPI Updating OpenAPI to consider DataStore endpoint managing only one record Add endpoint in plural * Add Data store as resource on Backend (#2385) * feat(frontend): add data store as resource (#2423) * Add data store as resource on CLI (#2422) * Updating DataStore API definition to consider ResourcesAPI structure (#2368) Fixing sorting fields on OpenAPI Updating OpenAPI to consider DataStore endpoint managing only one record Add endpoint in plural * Adding datastoreresource package * Update internal references to use datastoreresource package * Isolate database resources on each test * Adding behavior for no datastore scenario * Fixing rebase problems * Fixing another rebase problem * Updating DataStore API definition to consider ResourcesAPI structure (#2368) Fixing sorting fields on OpenAPI Updating OpenAPI to consider DataStore endpoint managing only one record Add endpoint in plural * Fixing merge * Adding documentation for delete operation * Improving cleanup code * Updating datastore API * Adding CLI generated code * wip * wip * Fixing CLI * deprecated old commands * Adding wrongly deleted file * simplifying the resource actions creation steps --------- Co-authored-by: Oscar Reyes <oscar-rreyes1@hotmail.com> * fix ingester dsRepo * chore(docs): update data store docs and examples (#2429) * removing test deletion * fixing provisioning file * fixing provisioning file --------- Co-authored-by: Jorge Padilla <jorge.esteban.padilla@gmail.com> Co-authored-by: Oscar Reyes <oscar-rreyes1@hotmail.com>
schoren
pushed a commit
that referenced
this pull request
Jun 5, 2023
… CLI commands (#2414) * Updating DataStore API definition to consider ResourcesAPI structure (#2368) Fixing sorting fields on OpenAPI Updating OpenAPI to consider DataStore endpoint managing only one record Add endpoint in plural * Add Data store as resource on Backend (#2385) * feat(frontend): add data store as resource (#2423) * Add data store as resource on CLI (#2422) * Updating DataStore API definition to consider ResourcesAPI structure (#2368) Fixing sorting fields on OpenAPI Updating OpenAPI to consider DataStore endpoint managing only one record Add endpoint in plural * Adding datastoreresource package * Update internal references to use datastoreresource package * Isolate database resources on each test * Adding behavior for no datastore scenario * Fixing rebase problems * Fixing another rebase problem * Updating DataStore API definition to consider ResourcesAPI structure (#2368) Fixing sorting fields on OpenAPI Updating OpenAPI to consider DataStore endpoint managing only one record Add endpoint in plural * Fixing merge * Adding documentation for delete operation * Improving cleanup code * Updating datastore API * Adding CLI generated code * wip * wip * Fixing CLI * deprecated old commands * Adding wrongly deleted file * simplifying the resource actions creation steps --------- Co-authored-by: Oscar Reyes <oscar-rreyes1@hotmail.com> * fix ingester dsRepo * chore(docs): update data store docs and examples (#2429) * removing test deletion * fixing provisioning file * fixing provisioning file --------- Co-authored-by: Jorge Padilla <jorge.esteban.padilla@gmail.com> Co-authored-by: Oscar Reyes <oscar-rreyes1@hotmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the OpenAPI definition to consider the DataStore API on the resources API architecture.
Note: We are only running
make generateto change the types on the backend PRs (#2385), just to avoid breaking things on this PR.Loom: https://www.loom.com/share/0870ffdc991b4f37b8e35faf281a6605
Changes
api/openapi.yamldefinitionsFixes
Checklist