Initial implementation of Azure developer signing dataplane service #26634
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
Jaxelr
requested review from
johanste and
mikekistler
and removed request for
a team
Next Steps to Merge✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM). |
Swagger Validation Report
|
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| 2023-06-15-preview | 2023-06-15-preview(1822759) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
3 tasks
|
Hi @Jaxelr! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. |
This was referenced Nov 9, 2023
mikekistler
requested changes
Nov 18, 2023
Jaxelr
force-pushed
the
jaxel/developer-signing-api-2023-06-15
branch
from
d6e3b91 to
7c5e17b
Compare
|
Thanks Mike, I just mark the PR to request review. |
mikekistler
approved these changes
Nov 21, 2023
|
@johanste could I get a second review, whenever you have a moment. Thanks. |
Jaxelr
force-pushed
the
jaxel/developer-signing-api-2023-06-15
branch
from
f876cde to
eb3f8ac
Compare
|
Looks like https://github.com/Azure/typespec-azure-pr/issues/3349 is reproing on the Swagger linter here. |
Per feedback from gh issue: Azure/typespec-azure-pr#3349
Jaxelr
force-pushed
the
jaxel/developer-signing-api-2023-06-15
branch
from
eb3f8ac to
1822759
Compare
|
hey @anuchandy based on @tjprescott guidance I added a suppression to the swagger linter. Could you please review and let me know what else is needed to Merge this PR? |
|
@Jaxelr this needs the sign-off from the API Stewardship board to merge. The Swagger suppression makes sense to me, but they have to approve the in-line suppressions in your TypeSpec. |
|
@tjprescott I'll post on the Azure API Stewardship teams. Thanks. |
|
API review issue: #23716 |
tjprescott
added
APIStewardshipBoard-SignedOff
arifibrahim4
pushed a commit
that referenced
this pull request
Feb 26, 2024
…26634) * feat: initial implementation of azure developer signing service * feat: Added optional headers of client version and correlation id * chore: compiled typespec project * docs: adding missing readme.md to data-plane spec * fix: adding words to customwords.txt * fix: Mark headers as optional * fix: Addition of Foundations.ErrorResponse or default errors * fix: rebase fixes * fix: per PR Feedback, modified the tspconfig to purge unreachable types * fix: examples are not configured for paging * fix: ran prettier on examples.json files * docs: adding swagger lint suppression Per feedback from gh issue: Azure/typespec-azure-pr#3349
3 tasks
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.
Data Plane API - Pull Request
This PR is accompanied by the following related PR. The purpose of this PR is the addition of the newly renamed Azure developer service to the specification.
This is the initial PR where Azure Code Signing was included.
Also See: https://github.com/Azure/typespec-azure-pr/issues/1999
cc: @DawnWang17, @ashutak84
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.
Is this review for (select one):
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links