Updating the API specification for confidential ledger for custom endpoints an… #30290
Conversation
…d custom roles change
amruthashree18
requested review from
allenjzhang and
mikekistler
and removed request for
a team
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Generated ApiView
|
…//github.com/amruthashree18/azure-rest-api-specs into amruthashree18/APISpecUpdate_customEndpoints
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
…//github.com/amruthashree18/azure-rest-api-specs into amruthashree18/APISpecUpdate_customEndpoints
…//github.com/amruthashree18/azure-rest-api-specs into amruthashree18/APISpecUpdate_customEndpoints
| }, | ||
| { | ||
| "$ref": "#/parameters/ModuleParameter" | ||
| } |
There was a problem hiding this comment.
GET operations may not have request bodies.
| }, | |
| { | |
| "$ref": "#/parameters/ModuleParameter" | |
| } | |
| } |
| "200": { | ||
| "description": "Module for user defined endpoints." | ||
| }, |
There was a problem hiding this comment.
This response should have a schema. I tried to figure out what should go here but it just wasn't obvious.
| { | ||
| "$ref": "#/parameters/RoleNameParameter" | ||
| } |
There was a problem hiding this comment.
GET operations may not have request bodies. Should this be a path or query param?
…//github.com/amruthashree18/azure-rest-api-specs into amruthashree18/APISpecUpdate_customEndpoints
…//github.com/amruthashree18/azure-rest-api-specs into amruthashree18/APISpecUpdate_customEndpoints
There was a problem hiding this comment.
There are still problems in this PR. Rather than continue to go back and forth on this, let me explain how you can check for these problems yourself.
There is a tool called Spectral that will check an API definition for structural correctness and adherence to common best practices. There are instructions on how to install Spectral and run Spectral with our custom ruleset here:
https://github.com/Azure/azure-api-style-guide/blob/main/README.md#how-to-use-the-spectral-ruleset
You must fix any issues that report as errors. Warnings and hints are less severe so you can ignore these for now.
Please request a re-review from me when you have done this.
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
…//github.com/amruthashree18/azure-rest-api-specs into amruthashree18/APISpecUpdate_customEndpoints
|
@mikekistler I have fixed the errors using spectral. Please review. |
| ], | ||
| "type": "object" | ||
| }, | ||
| "path": { |
There was a problem hiding this comment.
| "path": { | |
| "path": { | |
| "description": "A map of path to method endpoints for the path", |
| }, | ||
| "/app/userDefinedEndpoints/runTimeOptions": { | ||
| "get": { | ||
| "operationId": " GetRuntimeOptions ", |
There was a problem hiding this comment.
Best to avoid leading and trailing whitespace in operationIds.
| "operationId": " GetRuntimeOptions ", | |
| "operationId": "GetRuntimeOptions", |
| }, | ||
| { | ||
| "$ref": "#/parameters/BundleParameter" | ||
| } |
There was a problem hiding this comment.
You should add explicit support for If-Match header with etag to allow users to reliably update/replace endpoints.
mikekistler
added
the
APIStewardshipBoard-SignedOff
…d custom roles change
Data Plane API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
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
Getting help
write accessper aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositoriesNext Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.