Implement Models API Part #1 #14533
Merged
Implement Models API Part #1 #14533
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
azabbasi
force-pushed
the
feature/adt/azabbasi/secondIterationModelsAPI
branch
from
3ae9dba
to
68a49c1
Compare
azabbasi
requested review from
abhipsaMisra,
barustum,
bikamani,
drwill-ms,
prmathur-microsoft,
timtay-microsoft and
vinagesh
as code owners
azabbasi
commented
Aug 28, 2020
...ure-digitaltwins-core/src/main/java/com/azure/digitaltwins/core/DigitalTwinsAsyncClient.java
Show resolved
Hide resolved
azabbasi
commented
Aug 28, 2020
...ure-digitaltwins-core/src/main/java/com/azure/digitaltwins/core/DigitalTwinsAsyncClient.java
Outdated
Show resolved
Hide resolved
...ure-digitaltwins-core/src/main/java/com/azure/digitaltwins/core/DigitalTwinsAsyncClient.java
Show resolved
Hide resolved
...ure-digitaltwins-core/src/main/java/com/azure/digitaltwins/core/DigitalTwinsAsyncClient.java
Outdated
Show resolved
Hide resolved
...ure-digitaltwins-core/src/main/java/com/azure/digitaltwins/core/DigitalTwinsAsyncClient.java
Outdated
Show resolved
Hide resolved
bikamani
reviewed
Aug 28, 2020
| */ | ||
| @ServiceMethod(returns = ReturnType.SINGLE) | ||
| public Mono<ModelData> getModel(String modelId) { } | ||
|
|
||
| /** | ||
| * Gets a model, including the model metadata and the model definition asynchronously. | ||
| * @param modelId The Id of the model. | ||
| * @return A REST response containing the model. | ||
| * @return The ModelData and the http response |
There was a problem hiding this comment.
I have seen the format of "The Http response containing modelData"
We can decide one and use the same everywhere.
bikamani
reviewed
Aug 28, 2020
| */ | ||
| @ServiceMethod(returns = ReturnType.COLLECTION) | ||
| public Mono<Response<List<ModelData>>> createModelsWithResponse(List<String> models) { } | ||
| public PagedFlux<ModelData> createModels(List<String> models) { } | ||
|
|
||
| /** | ||
| * Gets a model, including the model metadata and the model definition. | ||
| * @param modelId The Id of the model. |
bikamani
reviewed
Aug 28, 2020
|
|
||
| /** | ||
| * Gets a model, including the model metadata and the model definition. | ||
| * @param modelId The Id of the model. | ||
| * @return The application/json model | ||
| * @return The ModelData | ||
| */ | ||
| @ServiceMethod(returns = ReturnType.SINGLE) | ||
| public Mono<ModelData> getModel(String modelId) { } | ||
|
|
||
| /** | ||
| * Gets a model, including the model metadata and the model definition asynchronously. | ||
| * @param modelId The Id of the model. |
There was a problem hiding this comment.
same here as above and other places
bikamani
reviewed
Aug 28, 2020
| * Creates one or many models. | ||
| * @param models The list of models to create. Each string corresponds to exactly one model. | ||
| * @return A REST response containing the list of created models. | ||
| * @return A {@link PagedIterable} of created ModelData. |
There was a problem hiding this comment.
Add a comment about context too?
There was a problem hiding this comment.
I will only update the actual implementation from now on
There was a problem hiding this comment.
What is part 2 suppose to contain?
Decommision and rest of it?
Decommission APIs and the Samples and tests.
bikamani
reviewed
Aug 28, 2020
bikamani
reviewed
Aug 28, 2020
| * @return A {@link PagedFlux} of ModelData and the http response. | ||
| */ | ||
| @ServiceMethod(returns = ReturnType.COLLECTION) | ||
| public PagedFlux<ModelData> listModels(ListModelOptions listModelOptions) { } |
There was a problem hiding this comment.
same here, with response?
bikamani
reviewed
Aug 28, 2020
| /** | ||
| * Deletes a model. | ||
| * @param modelId The id for the model. The id is globally unique and case sensitive. | ||
| * @return An empty Mono |
There was a problem hiding this comment.
do we even need to mention this return?
There was a problem hiding this comment.
Yes, we will get doc verification errors.
bikamani
approved these changes
Aug 28, 2020
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.
No description provided.