import "@typespec/http"; import "../dist/src/internal-decorators.js"; namespace TypeSpec.Rest.Resource; using Http; @doc("The default error response for resource operations.") model ResourceError { @doc("The error code.") code: int32; @doc("The error message.") message: string; } /** * Dynamically gathers keys of the model type `Resource`. * * @template Resource The target resource model. */ @doc("Dynamically gathers keys of the model type Resource.") @copyResourceKeyParameters @friendlyName("{name}Key", Resource) model KeysOf {} /** * Dynamically gathers parent keys of the model type `Resource`. * * @template Resource The target resource model. */ @doc("Dynamically gathers parent keys of the model type Resource.") @copyResourceKeyParameters("parent") @friendlyName("{name}ParentKey", Resource) model ParentKeysOf {} /** * Represents operation parameters for the resource of type `Resource`. * * @template Resource The resource model. */ @doc("Represents operation parameters for resource Resource.") model ResourceParameters { ...KeysOf; } /** * Represents collection operation parameters for the resource of type `Resource`. * * @template Resource The resource model. */ @doc("Represents collection operation parameters for resource Resource.") model ResourceCollectionParameters { ...ParentKeysOf; } /** * Represents the resource GET operation. * * @template Resource The resource model. * @template Error The error response. */ @Private.validateHasKey(Resource) @Private.validateIsError(Error) interface ResourceRead { /** * Gets an instance of the resource. */ @autoRoute @doc("Gets an instance of the resource.") @readsResource(Resource) get(...ResourceParameters): Resource | Error; } /** * Resource create operation completed successfully. * * @template Resource The resource model that was created. */ @doc("Resource create operation completed successfully.") model ResourceCreatedResponse { ...CreatedResponse; /** The created resource. */ @bodyRoot body: Resource; } /** * Resource create or replace operation template. * * @template Resource The resource model to create or replace. * @template Error The error response. */ interface ResourceCreateOrReplace { /** * Creates or replaces a instance of the resource. */ @autoRoute @doc("Creates or replaces an instance of the resource.") @createsOrReplacesResource(Resource) createOrReplace( ...ResourceParameters, /** The properties of the resource to create or replace. */ @doc("") @bodyRoot resource: ResourceCreateModel, ): Resource | ResourceCreatedResponse | Error; } /** * Resource create or update operation model. * * @template Resource The resource model to create or update. */ @friendlyName("{name}Update", Resource) model ResourceCreateOrUpdateModel is OptionalProperties>>; /** * Resource create or update operation template. * * @template Resource The resource model to create or update. * @template Error The error response. */ interface ResourceCreateOrUpdate { /** * Creates or update an instance of the resource. */ #suppress "@typespec/http/deprecated-implicit-optionality" "for legacy behavior" @autoRoute @doc("Creates or update an instance of the resource.") @createsOrUpdatesResource(Resource) @patch(#{ implicitOptionality: true }) // for legacy behavior createOrUpdate( ...ResourceParameters, /** The properties of the resource to create or update. */ @doc("") @bodyRoot resource: ResourceCreateOrUpdateModel, ): Resource | ResourceCreatedResponse | Error; } /** * Resource create operation model. * * @template Resource The resource model to create. */ @friendlyName("{name}Create", Resource) @withVisibility(Lifecycle.Create) model ResourceCreateModel is DefaultKeyVisibility; /** * Resource create operation template. * * @template Resource The resource model to create. * @template Error The error response. */ interface ResourceCreate { /** * Creates a new instance of the resource. */ @autoRoute @doc("Creates a new instance of the resource.") @createsResource(Resource) create( ...ResourceCollectionParameters, /** The properties of the resource to create. */ @doc("") @bodyRoot resource: ResourceCreateModel, ): Resource | ResourceCreatedResponse | Error; } /** * Resource update operation template. * * @template Resource The resource model to update. * @template Error The error response. */ @Private.validateHasKey(Resource) @Private.validateIsError(Error) interface ResourceUpdate { /** * Updates an existing instance of the resource. */ #suppress "@typespec/http/deprecated-implicit-optionality" "for legacy behavior" @autoRoute @doc("Updates an existing instance of the resource.") @updatesResource(Resource) @patch(#{ implicitOptionality: true }) // for legacy behavior update( ...ResourceParameters, /** The properties of the resource to update. */ @doc("") @bodyRoot properties: ResourceCreateOrUpdateModel, ): Resource | Error; } @doc("Resource deleted successfully.") model ResourceDeletedResponse { @doc("The status code.") @statusCode _: 200; } /** * Resource delete operation template. * * @template Resource The resource model to delete. * @template Error The error response. */ @Private.validateHasKey(Resource) @Private.validateIsError(Error) interface ResourceDelete { /** * Deletes an existing instance of the resource. */ @autoRoute @doc("Deletes an existing instance of the resource.") @deletesResource(Resource) delete(...ResourceParameters): ResourceDeletedResponse | Error; } /** * Structure for a paging response using `value` and `nextLink` to represent pagination. * * @template Resource The resource type of the collection. */ @doc("Paged response of {name} items", Resource) @friendlyName("{name}CollectionWithNextLink", Resource) model CollectionWithNextLink { @doc("The items on this page") @pageItems value: Resource[]; @doc("The link to the next page of items") @nextLink nextLink?: ResourceLocation; } /** * Resource list operation template. * * @template Resource The resource model to list. * @template Error The error response. */ interface ResourceList { /** * Lists all instances of the resource. */ @autoRoute @doc("Lists all instances of the resource.") @listsResource(Resource) list(...ResourceCollectionParameters): CollectionWithNextLink | Error; } /** * Resource operation templates for resource instances. * * @template Resource The resource model. * @template Error The error response. */ @Private.validateHasKey(Resource) @Private.validateIsError(Error) interface ResourceInstanceOperations extends ResourceRead, ResourceUpdate, ResourceDelete {} /** * Resource operation templates for resource collections. * * @template Resource The resource model. * @template Error The error response. */ @Private.validateHasKey(Resource) @Private.validateIsError(Error) interface ResourceCollectionOperations extends ResourceCreate, ResourceList {} /** * Resource operation templates for resources. * * @template Resource The resource model. * @template Error The error response. */ @Private.validateHasKey(Resource) @Private.validateIsError(Error) interface ResourceOperations extends ResourceInstanceOperations, ResourceCollectionOperations {} /** * Singleton resource read operation template. * * @template Singleton The singleton resource model. * @template Resource The resource model. * @template Error The error response. */ @Private.validateHasKey(Resource) @Private.validateIsError(Error) interface SingletonResourceRead { /** * Gets the singleton resource. */ @autoRoute @doc("Gets the singleton resource.") @segmentOf(Singleton) @readsResource(Singleton) get(...ResourceParameters): Singleton | Error; } /** * Singleton resource update operation template. * * @template Singleton The singleton resource model. * @template Resource The resource model. * @template Error The error response. */ @Private.validateHasKey(Resource) @Private.validateIsError(Error) interface SingletonResourceUpdate { /** * Updates the singleton resource. */ #suppress "@typespec/http/deprecated-implicit-optionality" "for legacy behavior" @autoRoute @doc("Updates the singleton resource.") @segmentOf(Singleton) @updatesResource(Singleton) @patch(#{ implicitOptionality: true }) // for legacy behavior update( ...ResourceParameters, /** The properties of the singleton resource to update. */ @doc("") @body properties: ResourceCreateOrUpdateModel, ): Singleton | Error; } /** * Singleton resource operation templates for singleton resource instances. * * @template Singleton The singleton resource model. * @template Resource The resource model. * @template Error The error response. */ interface SingletonResourceOperations extends SingletonResourceRead, SingletonResourceUpdate {} /** * Extension resource read operation template. * * @template Extension The extension resource model. * @template Resource The resource model. * @template Error The error response. */ @Private.validateHasKey(Resource) @Private.validateIsError(Error) interface ExtensionResourceRead { /** * Gets an instance of the extension resource. */ @autoRoute @doc("Gets an instance of the extension resource.") @readsResource(Extension) get(...ResourceParameters, ...ResourceParameters): Extension | Error; } /** * Extension resource create or update operation template. * * @template Extension The extension resource model. * @template Resource The resource model. * @template Error The error response. */ interface ExtensionResourceCreateOrUpdate { /** * Creates or update an instance of the extension resource. */ #suppress "@typespec/http/deprecated-implicit-optionality" "for legacy behavior" @autoRoute @doc("Creates or update an instance of the extension resource.") @createsOrUpdatesResource(Extension) @patch(#{ implicitOptionality: true }) // for legacy behavior createOrUpdate( ...ResourceParameters, ...ResourceParameters, /** The properties of the extension resource to create or update. */ @doc("") @bodyRoot resource: ResourceCreateOrUpdateModel, ): Extension | ResourceCreatedResponse | Error; } /** * Extension resource create operation template. * * @template Extension The extension resource model. * @template Resource The resource model. * @template Error The error response. */ interface ExtensionResourceCreate { /** * Creates a new instance of the extension resource. */ @autoRoute @doc("Creates a new instance of the extension resource.") @createsResource(Extension) create( ...ResourceParameters, /** The properties of the extension resource to create. */ @doc("") @bodyRoot resource: ResourceCreateModel, ): Extension | ResourceCreatedResponse | Error; } /** * Extension resource update operation template. * * @template Extension The extension resource model. * @template Resource The resource model. * @template Error The error response. */ interface ExtensionResourceUpdate { /** * Updates an existing instance of the extension resource. */ #suppress "@typespec/http/deprecated-implicit-optionality" "for legacy behavior" @autoRoute @doc("Updates an existing instance of the extension resource.") @updatesResource(Extension) @patch(#{ implicitOptionality: true }) // for legacy behavior update( ...ResourceParameters, ...ResourceParameters, /** The properties of the extension resource to update. */ @doc("") @body properties: ResourceCreateOrUpdateModel, ): Extension | Error; } /** * Extension resource delete operation template. * * @template Extension The extension resource model. * @template Resource The resource model. * @template Error The error response. */ interface ExtensionResourceDelete { /** * Deletes an existing instance of the extension resource. */ @autoRoute @doc("Deletes an existing instance of the extension resource.") @deletesResource(Extension) delete(...ResourceParameters, ...ResourceParameters): | ResourceDeletedResponse | Error; } /** * Extension resource list operation template. * * @template Extension The extension resource model. * @template Resource The resource model. * @template Error The error response. */ interface ExtensionResourceList { /** * Lists all instances of the extension resource. */ @autoRoute @doc("Lists all instances of the extension resource.") @listsResource(Extension) list(...ResourceParameters, ...ResourceCollectionParameters): | CollectionWithNextLink | Error; } /** * Extension resource operation templates for extension resource instances. * * @template Extension The extension resource model. * @template Resource The resource model. * @template Error The error response. */ interface ExtensionResourceInstanceOperations extends ExtensionResourceRead, ExtensionResourceUpdate, ExtensionResourceDelete {} /** * Extension resource operation templates for extension resource collections. * * @template Extension The extension resource model. * @template Resource The resource model. * @template Error The error response. */ interface ExtensionResourceCollectionOperations extends ExtensionResourceCreate, ExtensionResourceList {} /** * Extension resource operation templates for extension resource instances and collections. * * @template Extension The extension resource model. * @template Resource The resource model. * @template Error The error response. */ interface ExtensionResourceOperations extends ExtensionResourceInstanceOperations, ExtensionResourceCollectionOperations {}