Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import {
getResourceOperation,
isAzureResource,
resolveProviderNamespace,
getArmProviderNamespace,
getArmResource,
} from "@azure-tools/typespec-azure-resource-manager";
import { createRule, type Model, type ModelProperty } from "@typespec/compiler";
import { getHttpOperation, type HttpOperationResponse } from "@typespec/http";
Expand All @@ -20,7 +19,10 @@ export const xmsResourceInPutResponseRule = createRule({
return {
operation: (operation) => {
const namespace = operation.interface?.namespace ?? operation.namespace;
if (resolveProviderNamespace(context.program, namespace) === undefined) {
if (
namespace === undefined ||
getArmProviderNamespace(context.program, namespace) === undefined
) {
return;
}

Expand All @@ -29,10 +31,6 @@ export const xmsResourceInPutResponseRule = createRule({
return;
}

if (getResourceOperation(context.program, operation) !== undefined) {
return;
}

const responseModel = getPrimarySuccessResponseModel(httpOperation.responses);
if (responseModel === undefined) {
return;
Expand All @@ -43,7 +41,7 @@ export const xmsResourceInPutResponseRule = createRule({
}

if (
isAzureResource(context.program, responseModel) ||
getArmResource(context.program, responseModel) !== undefined ||
hasExplicitAzureResourceExtension(context.program, responseModel)
) {
return;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"violation": false,
"ambientDiagnostics": [
{
"code": "@azure-tools/typespec-azure-core/documentation-required",
"count": 1
},
{
"code": "@azure-tools/typespec-azure-resource-manager/arm-resource-operation",
"count": 2
},
{
"code": "tsp-lintdiff-local-linter/latest-version-of-common-types-must-be-used",
"count": 1
},
{
"code": "tsp-lintdiff-local-linter/path-parameter-schema",
"count": 1
},
{
"code": "tsp-lintdiff-local-linter/put-in-operation-name",
"count": 1
},
{
"code": "tsp-lintdiff-local-linter/xms-examples-required",
"count": 1
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import "../../lib/imports.tsp";

using TypeSpec.Http;
using TypeSpec.Rest;
using TypeSpec.Versioning;
using Azure.ResourceManager;

@armProviderNamespace
@service(#{ title: "Test Service" })
@versioned(Versions)
namespace Microsoft.TestService {
enum Versions {
@useDependency(Azure.ResourceManager.CommonTypes.Versions.v5)
@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v3)
v2024_01_01: "2024-01-01",
}

interface Operations extends Azure.ResourceManager.Operations {}
}

/** A global result that resembles a resource. */
model GlobalResult {
/** The resource name. */
name?: string;

/** The resource type. */
type?: string;
}

/** A global PUT outside the ARM provider namespace. */
@route("/global/{name}")
@put
op globalPut(@path name: string): GlobalResult;
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
{
"swagger": "2.0",
"info": {
"title": "Test Service",
"version": "2024-01-01",
"x-typespec-generated": [
{
"emitter": "@azure-tools/typespec-autorest"
}
]
},
"schemes": [
"https"
],
"host": "management.azure.com",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"description": "Azure Active Directory OAuth2 Flow.",
"flow": "implicit",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"tags": [
{
"name": "Operations"
}
],
"paths": {
"/providers/Microsoft.TestService/operations": {
"get": {
"operationId": "Operations_List",
"tags": [
"Operations"
],
"description": "List the operations for the provider",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
}
},
"definitions": {},
"parameters": {}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
[
{
"code": "tsp-lintdiff-local-linter/latest-version-of-common-types-must-be-used",
"severity": "warning",
"message": "Use the latest ARM common-types version 'v6' instead of 'v3'."
},
{
"code": "@azure-tools/typespec-azure-core/documentation-required",
"severity": "warning",
"message": "The ModelProperty named 'name' should have a documentation or description, use doc comment /** */ to provide it."
},
{
"code": "@azure-tools/typespec-azure-resource-manager/arm-resource-operation",
"severity": "warning",
"message": "All operations must be inside an interface declaration."
},
{
"code": "@azure-tools/typespec-azure-resource-manager/arm-resource-operation",
"severity": "warning",
"message": "All Resource operations must use an api-version parameter. Please include Azure.ResourceManager.ApiVersionParameter in the operation parameter list using the spread (...ApiVersionParameter) operator, or using one of the common resource parameter models."
},
{
"code": "tsp-lintdiff-local-linter/put-in-operation-name",
"severity": "warning",
"message": "'PUT' operation 'globalPut' should use method name 'create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change."
},
{
"code": "tsp-lintdiff-local-linter/path-parameter-schema",
"severity": "warning",
"message": "Path parameter should specify a maximum length (maxLength) and characters allowed (pattern)."
},
{
"code": "tsp-lintdiff-local-linter/xms-examples-required",
"severity": "warning",
"message": "Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations."
}
]
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[]
Loading