- name: Data API builder documentation href: index.yml - name: Overview expanded: true items: - name: What is Data API builder? displayName: overview href: overview.md - name: What's new displayName: changelog, diff, release href: whats-new/index.yml items: - name: DAB 1.5 (Feature release) href: whats-new/version-1-5.md - name: DAB 1.4 (Stability release) href: whats-new/version-1-4.md - name: DAB 1.3 (Feature release) href: whats-new/version-1-3.md - name: DAB 1.2 (Stability release) href: whats-new/version-1-2.md - name: DAB 1.1 (GA) href: whats-new/version-1-1.md - name: Feature availability href: feature-availability.md - name: FAQ displayName: frequently asked questions, Q&A href: faq.yml - name: Reference items: - name: Command-line interface displayName: CLI href: reference-command-line-interface.md - name: Configuration file items: - name: Configuration schema href: reference-configuration.md#schema - name: Complete configuration displayName: Config, JSON href: reference-configuration.md - name: Sections items: - name: Data source href: reference-configuration.md#data-source items: - name: Database type href: reference-configuration.md#database-type - name: Connection string href: reference-configuration.md#connection-string - name: Options href: reference-configuration.md#options - name: Data source files href: reference-configuration.md#data-source-files - name: Runtime href: reference-configuration.md#runtime items: - name: GraphQL displayName: API href: reference-configuration.md#graphql-runtime items: - name: Enabled href: reference-configuration.md#enabled-graphql-runtime - name: Path href: reference-configuration.md#path-graphql-runtime - name: Depth limit href: reference-configuration.md#graphql-runtime - name: Allow introspection href: reference-configuration.md#allow-introspection-graphql-runtime - name: Multiple mutations displayName: multiple create, transaction href: reference-configuration.md#multiple-mutations-graphql-runtime - name: REST displayName: API href: reference-configuration.md#rest-runtime items: - name: Enabled href: reference-configuration.md#enabled-rest-runtime - name: Path href: reference-configuration.md#path-rest-runtime - name: Request body strict displayName: dotnet, poco, dto href: reference-configuration.md#request-body-strict-rest-runtime - name: Host href: reference-configuration.md#host-runtime items: - name: Mode href: reference-configuration.md#host-runtime - name: Maximum response size href: reference-configuration.md#mode-host-runtime displayName: mb, megabyte - name: CORS href: reference-configuration.md#cors-host-runtime - name: Allow credentials href: reference-configuration.md#allow-credentials-host-runtime - name: Origins href: reference-configuration.md#origins-host-runtime - name: Authentication href: reference-configuration.md#authentication-host-runtime displayName: claims, predicate, item - name: Provider href: reference-configuration.md#provider-host-runtime - name: JSON Web Tokens displayName: JWT href: reference-configuration.md#json-web-tokens-host-runtime - name: Audience href: reference-configuration.md#audience-host-runtime - name: Issuer href: reference-configuration.md#issuer-host-runtime - name: Global Cache href: reference-configuration.md#cache-runtime items: - name: Enabled href: reference-configuration.md#enabled-cache-runtime - name: Time-to-live in seconds displayName: TTL href: reference-configuration.md#ttl-in-seconds-cache-runtime - name: Pagination href: reference-configuration.md#pagination-runtime items: - name: Default page size displayName: default-page-size href: reference-configuration.md#default-page-size-pagination-runtime - name: Maximum page size displayName: max-page-size href: reference-configuration.md#maximum-page-size-pagination-runtime - name: Entities href: reference-configuration.md#entities items: - name: REST href: reference-configuration.md#rest-entities items: - name: Enabled href: reference-configuration.md#enabled-rest-entity - name: Path href: reference-configuration.md#path-rest-entity - name: Methods href: reference-configuration.md#methods-rest-entity - name: GraphQL href: reference-configuration.md#graphql-entities items: - name: Enabled href: reference-configuration.md#enabled-graphql-entity - name: Type href: reference-configuration.md#type-graphql-entity - name: Operation href: reference-configuration.md#operation-graphql-entity - name: Source href: reference-configuration.md#source items: - name: Object href: reference-configuration.md#object - name: Type href: reference-configuration.md#type-entities - name: Key fields href: reference-configuration.md#key-fields - name: Parameters href: reference-configuration.md#parameters - name: Mappings displayName: field, column, property href: reference-configuration.md#mappings-entities - name: Entity Relationships href: reference-configuration.md#relationships-entities items: - name: Cardinality href: reference-configuration.md#cardinality - name: Target entity href: reference-configuration.md#target-entity - name: Source fields href: reference-configuration.md#source-fields - name: Target fields href: reference-configuration.md#target-fields - name: Linking object or entity href: reference-configuration.md#linking-object-or-entity - name: Linking source fields href: reference-configuration.md#linking-source-fields - name: Linking target fields href: reference-configuration.md#linking-target-fields - name: Cache href: reference-configuration.md#cache-entities items: - name: Enabled href: reference-configuration.md#enabled-cache-entity - name: Time-to-live in seconds displayName: TTL href: reference-configuration.md#ttl-in-seconds-cache-entity - name: Permissions displayName: Security, Policy, claims, predicate, item href: reference-configuration.md#permissions items: - name: Role href: reference-configuration.md#role - name: Actions (string-array) href: reference-configuration.md#actions-string-array - name: Actions (object-array) href: reference-configuration.md#actions-object-array items: - name: Action href: reference-configuration.md#action - name: Fields href: reference-configuration.md#fields - name: Policy href: reference-configuration.md#policy displayName: claims, predicate, item items: - name: Database href: reference-configuration.md#database - name: JSON Schema href: https://github.com/Azure/data-api-builder/blob/main/schemas/dab.draft.schema.json - name: The @env() Function displayName: env, environment, macro href: reference-functions.md - name: Supported data types href: reference-data-types.md - name: Database-specific features displayName: sql, cosmos, pg, postgres, mysql, dw href: reference-database-specific-features.md - name: Quickstarts items: - name: Local items: - name: SQL href: quickstart-sql.md - name: NoSQL displayName: Cosmos href: quickstart-nosql.md - name: PostgreSQL href: quickstart-postgresql.md - name: MySQL href: quickstart-mysql.md - name: Azure items: - name: Azure SQL displayName: database, server href: quickstart-azure-sql.md - name: Azure Cosmos DB for NoSQL href: quickstart-azure-cosmos-db-nosql.md - name: Deploy href: deployment/toc.yml - name: How to items: - name: Install the CLI displayName: DAB, command-line, interface href: how-to-install-cli.md - name: Run in a container href: how-to-run-container.md - name: Run from source code displayName: Git, GitHub, oss, repository, contribute href: how-to-run-from-source.md - name: Implement row-level security in SQL displayName: RLS, claims, predicate, item href: how-to-row-level-security.md - name: Use environments displayName: development href: how-to-use-environments.md - name: Batch multiple mutations displayName: multiple create, transaction href: how-to-multiple-mutations.md - name: Tutorials items: - name: Deploy to Azure Container Apps using Azure CLI displayName: ACA, automate, automation href: tutorial-deploy-container-app-cli.md - name: Concepts items: - name: REST displayName: HTTP, etag, header, put, patch, get, post, delete, select, filter, orderby, first, after href: rest.md - name: OpenAPI href: openapi.md - name: GraphQL href: graphql.md - name: Environments items: - name: Configuring environments href: environments.md - name: Setting environment variables displayName: $env, @env, vars, .env, env href: environments.md#setting-environment-variables - name: Accessing environment variables displayName: Environment variables, $env, @env, vars, env href: environments.md#accessing-environment-variables - name: Database objects items: - name: Views href: database-objects.md#views - name: Stored Procedures displayName: procs href: database-objects.md#stored-procedures - name: Relationships href: relationships.md - name: Authentication and authorization items: - name: Azure authentication displayName: AAD, AD, Azure Active Directory, Microsoft Entra Identity, Entra ID href: authentication-azure.md - name: Local authentication href: authentication-local.md - name: Authorization href: authorization.md - name: Code policies displayName: Versioning, Change, Breaking href: reference-policies.md - name: Samples items: - name: Example configuration displayName: Sample href: sample-configuration.md - name: Applications items: - name: Library app sample with Data API builder, SQL server, and Blazor displayName: ASP.NET, WebAssembly href: /samples/azure-samples/azure-sql-library-app-blazor/azure-sql-library-app-blazor - name: Todo app sample with Data API builder, Azure Static Web Apps, and Azure SQL displayName: To-do, to, do, to do href: /samples/azure-samples/dab-swa-todo/sample - name: Library app sample with Data API builder, Azure Static Web Apps, and Azure SQL displayName: Bookstore href: /samples/azure-samples/dab-swa-library-demo/sample - name: Sample devcontainer for Data API builder and Azure SQL Database displayName: Codespaces href: /samples/microsoft/vscode-remote-try-dab/devcontainer - name: Troubleshooting items: - name: Installation href: /troubleshoot/azure/data-api-builder/installation?context=/azure/data-api-builder/context/context - name: Runtime href: /troubleshoot/azure/data-api-builder/usage?context=/azure/data-api-builder/context/context - name: Known issues displayName: bugs href: https://github.com/azure/data-api-builder/labels/known-issue - name: Support displayName: ticket, css, feedback, help, assistance href: https://github.com/Azure/data-api-builder/blob/main/SUPPORT.md