azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
[Cosmos] Copied tables spec to stable
Data Plane API - Pull Request
Copy of the existing Tables specification from the "preview" directory to the "stable" directory. The spec and examples have not been modified.
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.
- Link to API Spec engagement record issue:
Is this review for (select one):
- [ ] a private preview
- [ ] a public preview
- [x] GA release
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.
- Design Document:
- Previous API Spec Doc:
- Updated paths:
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 ApiView comment 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.
- 💬 Teams Channel
Click here for links to tools, specs, guidelines & other good stuff
Tooling
- Open API validation tools were run on this PR. Go here to see how to fix errors
- Spectral Linting
- Open API Hub
Guidelines & Specifications
Helpful Links
Checks stuck in `queued` state?
If the PR CI checks appear to be stuck in `queued` state, please add a comment with contents `/azp run`. This should result in a new comment denoting a `PR validation pipeline` has started and the checks should be updated after few minutes.
Next Steps to Merge
Next steps that must be taken to merge this PR:- ❌ This is the public specs repo
mainbranch 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, addPublishToCustomerslabel to your PR.
Otherwise, retarget this PR onto a feature branch, i.e. with prefixrelease-(see aka.ms/azsdk/api-versions#release--branches). - ❌ The required check named
TypeSpec Requirement (data-plane)has failed. TypeSpec usage is required for all new (aka "greenfield") services. The automation detected this pull request adds at least one new service that is violating this requirement. For information on converting from OpenAPI specs to TypeSpec specs or on data-plane (DP) policies, refer to aka.ms/azsdk/typespec. If you have general questions on resource provider (RP) policies, refer to aka.ms/rphelp
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
| Compared specs (v0.10.9) | new version | base version |
|---|---|---|
| table.json | 2019-02-02(6a00260) | 2019-02-02(main) |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-2019-02 | package-2019-02(6a00260) | package-2019-02(main) |
| package-2019-02-preview | package-2019-02-preview(6a00260) | default(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The host parameter must be called 'endpoint'. Location: Microsoft.Tables/stable/2019-02-02/table.json#L16 |
|
The host parameter must be typed 'type 'string', format 'url''. Location: Microsoft.Tables/stable/2019-02-02/table.json#L16 |
|
Paths in x-ms-paths must overload a normal path in the paths section, i.e. a path in the x-ms-paths must either be same as a path in the paths section or a path in the paths sections followed by additional parameters. Location: Microsoft.Tables/stable/2019-02-02/table.json#L1058 |
|
Paths in x-ms-paths must overload a normal path in the paths section, i.e. a path in the x-ms-paths must either be same as a path in the paths section or a path in the paths sections followed by additional parameters. Location: Microsoft.Tables/stable/2019-02-02/table.json#L1210 |
|
The schema 'Metrics' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Tables/stable/2019-02-02/table.json#L1401 |
|
The integer type does not have a format, please add it. Location: Microsoft.Tables/stable/2019-02-02/table.json#L1476 |
|
The integer type does not have a format, please add it. Location: Microsoft.Tables/stable/2019-02-02/table.json#L1503 |
|
The integer type does not have a format, please add it. Location: Microsoft.Tables/stable/2019-02-02/table.json#L1744 |
| :warning: DeprecatedXmsCodeGenerationSetting | The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.Tables/stable/2019-02-02/table.json#L6 |
| :warning: LicenseHeaderMustNotBeSpecified | License header must not be specified inside x-ms-code-generation-settings. This is different for different sdks generated and is passed via command line/config file when generating the sdk. Location: Microsoft.Tables/stable/2019-02-02/table.json#L6 |
| :warning: SecurityDefinitionDescription | Security definition should have a description. Location: Microsoft.Tables/stable/2019-02-02/table.json#L22 |
| :warning: ListInOperationName | Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.Tables/stable/2019-02-02/table.json#L39 |
| :warning: PageableOperation | Based on the response model schema, operation 'Table_Query' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Tables/stable/2019-02-02/table.json#L39 |
| :warning: PaginationResponse | Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Tables/stable/2019-02-02/table.json#L39 |
| :warning: GetInOperationName | 'GET' operation 'Table_Query' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Tables/stable/2019-02-02/table.json#L43 |
| :warning: OperationId | OperationId for get method should contain 'Get' or 'list' Location: Microsoft.Tables/stable/2019-02-02/table.json#L43 |
| :warning: VersionPolicy | Operation does not define an 'api-version' query parameter. Location: Microsoft.Tables/stable/2019-02-02/table.json#L50 |
| :warning: ParameterNamesConvention | header parameter name 'DataServiceVersion' should be kebab case. Location: Microsoft.Tables/stable/2019-02-02/table.json#L57 |
| :warning: ParameterNamesConvention | Parameter name '$format' should not begin with '$' or '@'. Location: Microsoft.Tables/stable/2019-02-02/table.json#L60 |
| :warning: ParameterNamesConvention | Parameter name '$top' should not begin with '$' or '@'. Location: Microsoft.Tables/stable/2019-02-02/table.json#L63 |
| :warning: ParameterNamesConvention | Parameter name '$select' should not begin with '$' or '@'. Location: Microsoft.Tables/stable/2019-02-02/table.json#L66 |
| :warning: ParameterNamesConvention | Parameter name '$filter' should not begin with '$' or '@'. Location: Microsoft.Tables/stable/2019-02-02/table.json#L69 |
| :warning: ParameterNamesConvention | Parameter name 'NextTableName' should be camel case. Location: Microsoft.Tables/stable/2019-02-02/table.json#L73 |
| :warning: DefaultResponse | Operation is missing a default response. Location: Microsoft.Tables/stable/2019-02-02/table.json#L80 |
| :warning: VersionPolicy | Operation does not define an 'api-version' query parameter. Location: Microsoft.Tables/stable/2019-02-02/table.json#L126 |
| :warning: ParameterNamesConvention | header parameter name 'DataServiceVersion' should be kebab case. Location: Microsoft.Tables/stable/2019-02-02/table.json#L133 |
| :warning: ParameterNamesConvention | Parameter name '$format' should not begin with '$' or '@'. Location: Microsoft.Tables/stable/2019-02-02/table.json#L136 |
| :warning: Post201Response | Using post for a create operation is discouraged. Location: Microsoft.Tables/stable/2019-02-02/table.json#L147 |
| :warning: ErrorResponse | Error response schema should contain an object property named error.Location: Microsoft.Tables/stable/2019-02-02/table.json#L216 |
| :warning: PathCharacters | Path contains non-recommended characters. Location: Microsoft.Tables/stable/2019-02-02/table.json#L223 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 10 Errors, 0 Warnings failed [Detail]
️️✔️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
️❌ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=434778&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b", "detail":"Run.ps1 failed with exit code 1 " |
| Posted by Swagger Pipeline | How to fix these errors? |
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Swagger | Microsoft.Tables | https://apiview.dev/Assemblies/Review/57efa77d411a4a1a9f930aabd714c5dd?revisionId=c76d03b2867b4d9f9f0f7ae11aea5a31 |
Hi, @annatisch. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
![microsoft-github-policy-service[bot] avatar](https://avatars.githubusercontent.com/in/95686?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi, @annatisch. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.
Hi @pjohari-ms - are you able to help me with why the model validation pass is failing? The missing samples are all XML APIs - so no samples. I thought I had added the correct suppressions (it seems to be the same format used by the other Storage services with XML APIs) however the CI pass is still failing.... can you provide some guidance here?
Hi, @annatisch. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
Hi, @annatisch. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.