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.

Sign up for GitHub

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

Jump to bottom

Data Plane swagger for agriculture platform for Public Preview #32238

Open
wants to merge 62 commits into
base: main
Choose a base branch
from
Open

Data Plane swagger for agriculture platform for Public Preview #32238

wants to merge 62 commits into from

Conversation

ryuzakil
Copy link
Member

Choose a PR Template

Switch to "Preview" on this description then select one of the choices below.

Click here to open a PR for a Data Plane API.

Click here to open a PR for a Control Plane (ARM) API.

Click here to open a PR for only SDK configuration.

@ryuzakil ryuzakil requested a review from a team as a code owner January 20, 2025 17:15
@ryuzakil ryuzakil requested review from DominikMe and mario-guerra and removed request for a team January 20, 2025 17:15
@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jan 20, 2025 •
edited
Loading

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This is the public specs repo main branch which is not intended for iterative development.
    You must acknowledge that you understand that after this PR is merged, you won't be able to stop your changes from being published to Azure customers.
    If this is what you intend, add PublishToCustomers label to your PR.
    Otherwise, retarget this PR onto a feature branch, i.e. with prefix release- (see aka.ms/azsdk/api-versions#release--branches).
  • ❌ The required check named Swagger LintDiff has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide

@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jan 20, 2025 •
edited
Loading

Generated ApiView

Language Package Name ApiView Link
JavaScript @azure-rest/agricultureplatform https://apiview.dev/Assemblies/Review/a382c81b227245b89bbe67c7437199fb?revisionId=d6a0a421e65f40c28ad4f798da4a3193

@azure-sdk
Copy link
Collaborator

azure-sdk commented Jan 20, 2025 •
edited
Loading

API change check

APIView has identified API level changes in this PR and created following API reviews.

Microsoft.AgriculturePlatform
Microsoft.AgriculturePlatform

@AzureRestAPISpecReview AzureRestAPISpecReview added the TypeSpec Authored with TypeSpec label Jan 31, 2025
@openapi-pipeline-app openapi-pipeline-app
Copy link

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

@openapi-pipeline-app openapi-pipeline-app
Copy link

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

This was referenced Mar 3, 2025
Draft
Draft
DominikMe
DominikMe reviewed Mar 5, 2025
View reviewed changes
specification/agricultureplatform/AgriculturePlatform.DataPlane/models.tsp Outdated

@parentResource(Catalog)
@resource("items")
model ItemsinCatalog is Item;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
model ItemsinCatalog is Item;
model ItemsInCatalog is Item;

specification/agricultureplatform/AgriculturePlatform.DataPlane/routes.tsp
* Creates or updates a Item resource.
*/
@action("create")
create is Operations.ResourceCollectionAction<
Copy link
Member

@DominikMe DominikMe Mar 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you try using https://azure.github.io/typespec-azure/docs/libraries/azure-core/reference/interfaces/#Azure.Core.ResourceOperations.ResourceCreateWithServiceProvidedName? If so, then you can probably also delete the ItemResponse model

...tform/AgriculturePlatform.DataPlane/examples/2024-11-01-preview/Catalogs_CreateOrUpdate.json Outdated
"parameters": {
"api-version": "2024-11-01-preview",
"catalogId": "CATALOG123",
"catalog": {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think CI is complaining because this isn't named resource. Please look into fixing CI failures and reach out in the TypeSpec Discussion channel as needed

@ryuzakil ryuzakil changed the title Data Plane swagger for agriculture platform for Private Preview Data Plane swagger for agriculture platform for Public Preview Mar 5, 2025
@mikekistler mikekistler linked an issue Mar 5, 2025 that may be closed by this pull request
[Microsoft Azure Data Manager for Agriculture - Microsoft Azure Data Manager for Agriculture] API Review #28833
Open
@mikekistler mikekistler added the APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. label Mar 5, 2025
DominikMe
DominikMe approved these changes Mar 7, 2025
View reviewed changes
Copy link
Member

@DominikMe DominikMe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for following through on the suggested refactorings, looks good!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Keshav-punia Keshav-punia Keshav-punia left review comments

@DominikMe DominikMe DominikMe approved these changes

@mario-guerra mario-guerra Awaiting requested review from mario-guerra mario-guerra is a code owner automatically assigned from Azure/api-stewardship-board

Assignees
No one assigned
Labels
APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. data-plane new-api-version SuppressionReviewRequired TypeSpec Authored with TypeSpec
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Microsoft Azure Data Manager for Agriculture - Microsoft Azure Data Manager for Agriculture] API Review
8 participants
@ryuzakil @azure-sdk @DominikMe @Keshav-punia @AzureRestAPISpecReview @mikekistler @msft-akhatri @lavisha1507