diff --git a/README.md b/README.md index 838227728eb7..49db1c9d7156 100644 --- a/README.md +++ b/README.md @@ -20,157 +20,7 @@ External Contributors can read [Getting Started with OpenAPI Specifications](htt ## Directory Structure -The structure of the directory should strictly follow these rules: - -1. **Profile**: The profile folder contains the profiles' definition files. The profile definition targets for hybrid applications that could run on Azure Stack general availability versions and Azure Cloud. - -2. **Specification**: This folder is the root folder for all Specs (Management Plane and Data Plane) related documents. - -3. **{RP-Name} Folders** - each resource provider should have at least one separate folder. - > If multiple folders are required? It depends on the following considerations: - > - > - An RP folder leads to a separate SDK package. Is it expected to have separate SDK packages for different service/component entities? - > - Service/component entities in one folder share the same versioning cycle. Can service/component entities in one folder share the same version label, and upgrade together in the future? - > - Specification files and AutoRest configuration files in one RP folder are better to refer to files in the same RP folder. Note: Entity type definition that needs to be referred cross RP folders should be placed and maintained under the folder [**common-types**](https://github.com/Azure/azure-rest-api-specs#common-types). - > - For more considerations, you may consult the reviewer in API design review. To initiate the review, Please submit an [Azure SDK intake questionnaire](https://aka.ms/sdk-apex). - - RP folders may contain resource manager or data plane TypeSpec "specs". TypeSpec is a language for describing cloud service APIs and generating other API description languages, client and service code, documentation, and other assets. Explore more by visiting the tutorial in the TypeSpec repo: [TypeSpec tutorial](http://aka.ms/cadlTutorial). You can also ask questions for providing feedback in the internal Teams channel [TypeSpec Discussion](https://teams.microsoft.com/l/channel/19%3a906c1efbbec54dc8949ac736633e6bdf%40thread.skype/Cadl%2520Discussion%2520%25F0%259F%2590%25AE?groupId=3e17dcb0-4257-4a30-b843-77f47f1d4121&tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47). - - For more information about the structure of TypeSpec files in the repo see [TypeSpec repo structure](https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/typespec-structure-guidelines.md). - -5. **'resource-manager' and 'data-plane' Folders**: the RPs can put specs in one of two categories: `resource-manager` (for ARM resources) and `data-plane` (for everything else). There should be an AutoRest configuration file (`readme.md`) for the RP inside both of these folders when present. - -6. **'Microsoft.{ARMNamespace}' Folders**: the folders are only required under the 'resource-manager' folder, which means only management-plane API specs require to have ARM Namespace in the file path. For ARM Namespace and ARM onboarding, please refer to the ARM wiki of [RP Onboarding](https://armwiki.azurewebsites.net/rp_onboarding/process/onboarding.html#0-on-boarding-meeting). - -7. **'preview' and 'stable' Folders**: This maps to the service/component lifecycle stage: Preview and GA. For example, if a service is in Preview stage, no matter Private Preview or Public Preview, the API specs of the service should be placed in the `preview` folder. If the service is GAed, but a component is in preview, then the API version contains the preview component entity should be placed in the `preview` folder as well. The `stable` folder should contain API versions of a GAed service and all GAed components. - - > How's the Azure Breaking Change Policy apply to API specs in `preview` and `stable` folders? In fact, it is more relevant to if the repo is public or private. - > - API specs with components or resource types in Private Preview, or Limited Public Preview (behind [AFEC](https://armwiki.azurewebsites.net/rp_onboarding/afec/FeatureExposureControl.html) or managing visible subscriptions) are better to launch PR review in the private repository, aka., [azure-rest-api-specs-pr](https://github.com/Azure/azure-rest-api-specs-pr). And these API specs are free of breaking changes. - > - > - On the other hand, everything public in the main branch of the public repository, aka., [azure-rest-api-specs](https://github.com/Azure/azure-rest-api-specs), no matter in the `preview` folder or in the `stable` folder, should be treated as contract with Azure customers, must follow [Azure Breaking Changes Policy](http://aka.ms/AzBreakingChangesPolicy). - -8. **API Versions Folders**: this folder is the direct child of the `preview` or `stable` folder. This folder contains the REST API Specs, and the `examples` folder. - -9. **'examples' Folders**: the example folder will contain the x-ms-examples files. it will reside under the APIs or Resources' version folders as different APIs or Resource types version can have different examples. - -> Note: some general guidance for folder names, and file names under `specification`: -> -> - Folder names should be singular (ie, 'profile' not 'profiles' ) -- this removes ambiguity for some non-english speakers. -> - Generic folder names should be lower-case -> - Namespace folders can be PascalCased (ie, "KeyVault") -> - Files are whatever case you think is good for your soul. - - -The structure should appear like so: -```bash -. -\---specification -| +---automation -| | \---resource-manager -| | +---Microsoft.Automation -| | | \---stable -| | | \---2015-10-31 -| | | \---examples -| | \---readme.md -| +---batch -| | +---data-plane -| | | +---stable -| | | | +---2016-07-01 -| | | | | \---examples -| | | | \---2017-01-01 -| | | | \---examples -| | | +---preview -| | | | \---2017-05-01-preview -| | | | \---examples -| | | \---readme.md -| | \---resource-manager -| | +---Microsoft.Batch -| | | \---stable -| | | +---2015-12-01 -| | | | \---examples -| | | +---2017-01-01 -| | | | \---examples -| | | \---2017-05-01 -| | | \---examples -| | \---readme.md -| \---playfab -| +---Playfab -| | \---tspconfig.yaml -| | \---main.tsp -| \--resource-manager -| +---Microsoft.Playfab -| | +---stable -| | | \---2017-02-27-preview -| | | \---examples -| | \---preview -| | \---2017-04-24-preview -| | \---examples -| \---readme.md -``` - -### Folder Structure for Service Group - -If you are working on API specification of a service group, then you may choose to build a folder structure as below. This folder structure brings more flexibility in multiple service teams collaboration, especially supporting: - -- To collect API definition of multiple components/services with different versioning cycle in one rp folder -- To share some common entity types among services or components under the same rp folder. - -In the following folder structure sample, there is only 'resource-manager' folder. There could be a similar folder structure under 'data-plane' folder, while the sub-component/sub-service folders may not be the same. - -Ensure to consult [API Spec Review](https://aka.ms/azsdk/support/specreview-channel) for the first time creating the folder structure or if you want to change current folder structure. - -```bash -. -\---specification -| +---compute -| | \---resource-manager -| | +---Microsoft.Compute -| | | +---compute -| | | | \---stable -| | | | \---2021-11-01 -| | | | +---compute.json -| | | | +---runCommands.json -| | | | \---examples -| | | +---sku -| | | | \---stable -| | | | \---2021-07-01 -| | | | +---skus.json -| | | | \---examples -| | | +---disk -| | | | \---stable -| | | | \---2021-12-01 -| | | | +---disk.json -| | | | \---examples -| | | +---gallery -| | | | \---stable -| | | | \---2021-10-01 -| | | | +---gallery.json -| | | | \---examples -| | | +---sharedgallery -| | | | \---stable -| | | | \---2021-07-01 -| | | | +---sharedGallery.json -| | | | +---communityGallery.json -| | | | \---examples -| | | +---cloudService -| | | | \---stable -| | | | \---2021-03-01 -| | | | +---cloudService.json -| | | | \---examples -| | | \---common-types -| | | \---v1 -| | | \---entity-types.json -| | | -| | \---readme.md -``` - -If the AutoRest configuration file (aka. the readme.md) is placed out of sub-service/sub-component folders, then there will be only one SDK package that holds all sub-services/sub-components. If the file is placed in each sub-service/sub-component folder, then there will be separate SDK packages of each sub-service/sub-component. Ensure to consult [Azure SDK ArchBoard](https://aka.ms/azsdk/onboarding/archboardschedule) for SDK packaging strategy when consolidating AutoRest configuration file for SDK generation. - -### common-types - -Specification files and AutoRest configuration files in one RP folder are better to refer to files in the same RP folder. Entity type definition that can be shared cross resource providers or services should to be placed and maintained either under the folder [**common-types**](https://github.com/Azure/azure-rest-api-specs#common-types) under specification, or under **common-types** folder of service group folder structure. The former supports the entity type sharing cross rp folders, while the latter supports the entity type sharing cross components or services under the same rp folder. - -Refer to [Resource-Management](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/common-types/resource-management) common types for example. +See [directory-structure.md](./documentation/directory-structure.md) for details on the directory structure of this repository. ## Next steps @@ -180,3 +30,4 @@ External Contributors can read [Getting Started with OpenAPI Specifications](htt --- _This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments._ + diff --git a/documentation/directory-structure.md b/documentation/directory-structure.md new file mode 100644 index 000000000000..adb8b6bee041 --- /dev/null +++ b/documentation/directory-structure.md @@ -0,0 +1,247 @@ +| Short Link: | [aka.ms/azsdk/spec-dirs](https://aka.ms/azsdk/spec-dirs) | +|--|--| + + + +- [`specification` directory structure](#specification-directory-structure) + - [`specification` folder](#specification-folder) + - [`resource-manager` and `data-plane` folders](#resource-manager-and-data-plane-folders) + - [AutoRest configuration `README.md` files](#autorest-configuration-readmemd-files) + - [`stable` and `preview` folders](#stable-and-preview-folders) + - [A complete example directory structure of `specification/`](#a-complete-example-directory-structure-of-specificationazureteam) + - [Naming guidelines for `specification` folder contents](#naming-guidelines-for-specification-folder-contents) + - [`specification/common-types`](#specificationcommon-types) + - [Advanced scenario: service group](#advanced-scenario-service-group) + - [Service group `common-types`](#service-group-common-types) + - [Versioning services in a service group](#versioning-services-in-a-service-group) + - [Deprecated structure and hand-written OpenAPI specs](#deprecated-structure-and-hand-written-openapi-specs) +# `specification` directory structure + + +This article describes the directory structure / folder layout of the `specification` folder. +You may be also interested in following: +- [Specification index] +- [Resource Provider list] + +> [!IMPORTANT] +> The structure described in this article is strictly enforced. There exist some exceptions for historical reasons. +> These exceptions are not allowed going forward. + +## `specification` folder + +The `specification` folder is the root folder for all service specifications. + +Each child of the `specification` folder corresponds to a `service` specification for given Azure team. Here we denote such folder as ``. +In advanced cases for big teams the `` folder can host multiple services, known as `service group`. +Read [the relevant section](#advanced-scenario-service-group) for details. + +Given `` has following structure: + +- `/` (multiple folders) +- `/resource-manager` +- `/data-plane` + +The `/` folders contain the TypeSpec specification for the given `service` or `service group`. +You can find details on the name and contents of these folders in [TypeSpec directory structure]. +You can learn more about TypeSpec at [aka.ms/azsdk/typespec] and [aka.ms/typespec]. + +## `resource-manager` and `data-plane` folders + +The `/resource-manager` contains the ARM OpenAPI specifications emitted from TypeSpec in `/`. + +The `resource-manager` folder has exactly one child folder whose name matches the **Resource Provider (RP) Namespace** (``), +such as `Microsoft.Automation` (full list of namespaces is [here][Resource Provider list]). +There is 1 to 1 correspondence between an RP and an RP namespace. +There must be **exactly one** RP namespace folder under given `resource-manager` folder. +We denote such folder as `resource-manager/`. + +The `/data-plane` contains the data-plane OpenAPI specifications emitted from TypeSpec in ``. +The `data-plane` folder has no child `` folder. However, it can have a set of `` folders. + +## AutoRest configuration `README.md` files + +Both the `/resource-manager` and `/data-plane` folders must contain an AutoRest configuration file, `README.md`. +Learn more about this file at [aka.ms/azsdk/autorest]. + + + +Each `README.md` describes a single `service` and is used as an SDK package and documentation for each version of the service. +Inside the `README.md` file there are lists of paths to OpenAPI spec `.json` files making up given service version. + +> [!NOTE] +> All OpenAPI specs for given service version (i.e. the list of paths in given `input-file:` block in the `README.md`) must have the same service version, +> which also means being in the same [API version lifecycle stage][aka.ms/azsdk/api-versions]. + +## `stable` and `preview` folders + +Both `/resource-manager/` and `/data-plane/` folders, in addition to containing `README.md`, also can contain +`stable` and `preview` folders. These folders contain OpenAPI specs in the `stable` and `preview` [lifecycle stages][aka.ms/azsdk/api-versions] +respectively, organized in `` subfolders for each service API version. For example, `/resource-manager//stable/` or +`/data-plane//preview/`. + +Each such API version folder directly contains a set of `.json` files containing OpenAPI specs emitted from TypeSpec, as well as an `examples` child folder +with `.json` files having the contents of [`x-ms-examples`] referenced from the OpenAPI specs. + +## A complete example directory structure of `specification/` + +Putting everything together discussed, the directory structure of a singular `specification//` is as follows: + +``` yaml +/1/... +/2/... # multiple '' folders + +/resource-manager/README.md +/resource-manager//stable//*.json +/resource-manager//stable//examples/*.json + // ... # multiple 'apiVer' folders +/resource-manager//preview//*.json +/resource-manager//preview//examples/*.json + // ... # multiple 'apiVer-preview' folders + +/data-plane/README.md +/data-plane//stable//*.json +/data-plane//stable//examples/*.json + // ... # multiple 'apiVer' folders +/data-plane//preview//*.json +/data-plane//preview//examples/*.json + // ... # multiple 'apiVer-preview' folders + // ... # multiple '' folders + +``` + +As a specific example of the above, consider [`specification/confidentialledger`] `` which has the following structure: + +``` yaml + +# ===== s + +/Microsoft.CodeTransparency/ +/Microsoft.ManagedCcf/ + +# ===== data-plane + +/data-plane/README.md + +# ----- : Microsoft.CodeTransparency + +/data-plane/Microsoft.CodeTransparency/preview/2024-01-11-preview +/data-plane/Microsoft.CodeTransparency/preview/2024-01-11-preview/examples + +# ----- : Microsoft.ConfidentialLedger + +/data-plane/Microsoft.ConfidentialLedger/stable +/data-plane/Microsoft.ConfidentialLedger/stable/2022-05-13 +/data-plane/Microsoft.ConfidentialLedger/stable/2022-05-13/examples + +/data-plane/Microsoft.ConfidentialLedger/preview +/data-plane/Microsoft.ConfidentialLedger/preview/2023-01-18-preview +/data-plane/Microsoft.ConfidentialLedger/preview/2023-01-18-preview/examples +# ... more previews here + +# ----- : Microsoft.ManagedCcf + +/data-plane/Microsoft.ManagedCcf/preview/2023-06-01-preview +/data-plane/Microsoft.ManagedCcf/preview/2023-06-01-preview/examples + +# ===== resource-manager + +/resource-manager/README.md + +# ----- resource-manager RP Namespace (): Microsoft.ConfidentialLedger + +/resource-manager/Microsoft.ConfidentialLedger/stable/2022-05-13 +/resource-manager/Microsoft.ConfidentialLedger/stable/2022-05-13/examples + +/resource-manager/Microsoft.ConfidentialLedger/preview/2023-06-28-preview +/resource-manager/Microsoft.ConfidentialLedger/preview/2023-06-28-preview/examples +# ... more previews here +/resource-manager/Microsoft.ConfidentialLedger/preview/2020-12-01-preview +/resource-manager/Microsoft.ConfidentialLedger/preview/2020-12-01-preview/examples + +``` + +For another example, see [`specification/eventgrid`]. + +## Naming guidelines for `specification` folder contents + +- Folder names should be singular (e.g. `keyvault` not `keyvaults` ) -- this removes ambiguity for some non-english speakers. +- Generic folder names should be lower-case. +- Resource Provider Namespace (``) folders can be PascalCased (e.g. `KeyVault`). +- For file names, any casing is allowed. +- When in doubt, mimic naming of the examples provided in this article. + +## `specification/common-types` + +The special directory of [`specification/common-types`] contains shared definitions that can be reused across all Azure team services in their +`specification` child folders. + +## Advanced scenario: service group + +In case of big Azure teams, their `specification/` hosts multiple services, together known as `service group`. +The main difference between one service and a service group is how they are presented to Azure customers: +One service has one SDK package and one documentation portal, while a service group has separate SDK package for each service and separate documentation. + +For example, [`specification/containerservice`] is a `service group` for both `aks` and `fleet` services. + +The doc for `aks` is [Azure Kubernetes Service]. It points to aks REST reference e.g. for [API version `2024-01-01`][aks REST reference 2024-01-01], +which corresponds to [`specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-01-01`]. + +The doc for `fleet` is [Azure Kubernetes Fleet Manager]. It point to fleet REST reference, e.g. for [API version `2023-10-15`][fleet REST reference 2023-10-15], +which corresponds to [`specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2023-10-15`]. + +Using our example, note the most important directory structure difference of a `service group` scenario as compared to singular `service`: + +- The `resource-manager/Microsoft.ContainerService` folder has multiple child service folders which contain `stable` and `preview` folders for each service, + instead of directly containing `stable` and `preview` folders. +- Each of the `aks` and `fleet` subfolders have their own `README.md` file, instead of there being one `README.md` in the `resource-manager` folder. + As a result, the SDKs of these services are separate. + +### Service group `common-types` + +A service group can also introduce its own set of `common-types` which are too general to be shared across all Azure teams but common enough to be +shared across all services in given service group. For an example, see [`Microsoft.Compute/common-types`]. + +### Versioning services in a service group + +The versioning policy for API and SDK packages applies independently to each service in the service group. +This means that each service in the service group must obey the same versioning rules as it were a singular service. +However, multiple separate services can have different versioning cycles, including different SDK packages. Refer to the aforementioned `aks` and `fleet` +services for examples of different versioning cycles in a service group. + +## Deprecated structure and hand-written OpenAPI specs + +As mentioned at the beginning of this article, for historical reasons, some `specification/` folders may +violate some of the constraints presented in this article. This includes violations like: + +- More deeply nested subfolders than allowed. +- Incorrect lack of `-preview` suffix in `preview` API versions. +- Mixing of `stable` and `preview` API versions in the same folder subtree. +- Mixing of multiple API versions in given `README.md` package, including mixing of multiple API version lifecycle stages. + +In addition, some `` folders have OpenAPI specs that have been written manually instead of emitted from TypeSpec. +In some cases the folders have mixture of manually-written and TypeSpec-emitted OpenAPI specs. + +All of the aforementioned cases are considered legacy and are not allowed going forward. + +[`Microsoft.Compute/common-types`]: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/compute/resource-manager/Microsoft.Compute/common-types/ +[`specification/common-types`]: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/common-types +[`specification/confidentialledger`]: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/confidentialledger +[`specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-01-01`]: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-01-01 +[`specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2023-10-15`]: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/containerservice/resource-manager/Microsoft.ContainerService/fleet/stable/2023-10-15 +[`specification/containerservice`]: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/containerservice +[`specification/eventgrid`]: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/eventgrid +[`x-ms-examples`]: https://azure.github.io/autorest/extensions/#x-ms-examples +[aka.ms/azsdk/api-versions]: https://aka.ms/azsdk/api-versions +[aka.ms/azsdk/autorest]: https://aka.ms/azsdk/autorest +[aka.ms/azsdk/typespec]: https://aka.ms/azsdk/typespec +[aka.ms/typespec]: https://aka.ms/typespec +[aks REST reference 2024-01-01]: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-01-01 +[Azure Kubernetes Fleet Manager]: https://learn.microsoft.com/en-us/azure/kubernetes-fleet/ +[Azure Kubernetes Service]: https://learn.microsoft.com/en-us/azure/aks/ +[fleet REST reference 2023-10-15]: https://learn.microsoft.com/en-us/rest/api/fleet/operation-groups?view=rest-fleet-2023-10-15 +[Resource Provider list]: https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/azure-services-resource-providers#match-resource-provider-to-service +[Specification index]: https://azure.github.io/azure-sdk/releases/latest/all/specs.html +[TypeSpec directory structure]: https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/typespec-structure-guidelines.md