Add sample metadata configuration

packages/samples/README.md

@@ -7,6 +7,11 @@ It is not published as an npm package.
 Samples should teach a distinct TypeSpec concept or realistic workflow. Narrow protocol test
 cases belong in the relevant package test suite instead of this collection.
 
+Each sample directory has a `sample-config.yaml` containing a unique `title` and a
+`description`. Set `playground: false` for samples that require multiple files or are not suitable
+for the playground. A directory config uses `directory: true` and can provide a gallery `label`,
+`danger`, or an inherited `playground: false`.
+
 ```bash
 npm run test    # Check Samples match snapshots
 npm run test:ci # run test same as CI

packages/samples/package.json

@@ -58,7 +58,8 @@
     "@typespec/rest": "workspace:^",
     "@typespec/sse": "workspace:^",
     "@typespec/streams": "workspace:^",
-    "@typespec/versioning": "workspace:^"
+    "@typespec/versioning": "workspace:^",
+    "yaml": "catalog:"
   },
   "devDependencies": {
     "@types/node": "catalog:",

packages/samples/specs/authentication/sample-config.yaml

@@ -0,0 +1,3 @@
+title: Authentication
+description: Apply authentication schemes at service, interface, and operation scope.
+playground: false

packages/samples/specs/binary/sample-config.yaml

@@ -0,0 +1,3 @@
+title: Binary data
+description: Model binary request and response payloads.
+playground: false

packages/samples/specs/documentation/sample-config.yaml

@@ -0,0 +1,3 @@
+title: Documentation
+description: Add documentation to TypeSpec declarations and emitted API descriptions.
+playground: false

packages/samples/specs/emitters/graphql/sample-config.yaml

@@ -0,0 +1,2 @@
+title: GraphQL
+description: Generate a GraphQL schema with queries, mutations, models, and enums.

packages/samples/specs/emitters/json-schema/sample-config.yaml

@@ -0,0 +1,2 @@
+title: JSON Schema
+description: Generate JSON Schema documents from TypeSpec models and constraints.

packages/samples/specs/emitters/protobuf-kiosk/sample-config.yaml

@@ -0,0 +1,2 @@
+title: Protobuf kiosk
+description: Generate Protocol Buffer service and message definitions for a kiosk system.

packages/samples/specs/emitters/sample-config.yaml

@@ -0,0 +1,2 @@
+directory: true
+label: Emitters

packages/samples/specs/encoded-names/sample-config.yaml

@@ -0,0 +1,3 @@
+title: Encoded names
+description: Customize declaration names for specific emitters.
+playground: false

packages/samples/specs/encoding/sample-config.yaml

@@ -0,0 +1,3 @@
+title: Value encoding
+description: Configure serialization formats for scalar values.
+playground: false

packages/samples/specs/getting-started/http-service/sample-config.yaml

@@ -0,0 +1,2 @@
+title: HTTP service
+description: Build an HTTP service with routes, parameters, request bodies, and responses.

packages/samples/specs/getting-started/rest-framework/sample-config.yaml

@@ -0,0 +1,2 @@
+title: REST framework
+description: Use resource-oriented REST templates to define a service with less repetition.

packages/samples/specs/getting-started/sample-config.yaml

@@ -0,0 +1,2 @@
+directory: true
+label: Getting Started

packages/samples/specs/grpc-kiosk-example/sample-config.yaml

@@ -0,0 +1,3 @@
+title: Advanced gRPC kiosk
+description: Demonstrate a multi-file Protobuf-oriented kiosk service.
+playground: false

packages/samples/specs/grpc-library-example/sample-config.yaml

@@ -0,0 +1,3 @@
+title: Protobuf library
+description: Build and consume reusable Protobuf declarations.
+playground: false

packages/samples/specs/init/sample-config.yaml

@@ -0,0 +1,3 @@
+title: Project initialization
+description: Show the service generated by the TypeSpec project initializer.
+playground: false

packages/samples/specs/language/api-versioning/sample-config.yaml

@@ -0,0 +1,2 @@
+title: API versioning
+description: Evolve an API across versions with version-aware types and operations.

packages/samples/specs/language/discriminated-unions/sample-config.yaml

@@ -0,0 +1,2 @@
+title: Discriminated unions
+description: Model polymorphic values with a discriminated union.

packages/samples/specs/language/sample-config.yaml

@@ -0,0 +1,2 @@
+directory: true
+label: Language

packages/samples/specs/local-typespec/sample-config.yaml

@@ -0,0 +1,3 @@
+title: Local TypeSpec installation
+description: Configure an editor to use a project-local TypeSpec compiler.
+playground: false

packages/samples/specs/multipart/sample-config.yaml

@@ -0,0 +1,3 @@
+title: Multipart requests
+description: Define multipart form data with files and structured fields.
+playground: false

packages/samples/specs/openapi-extensions/sample-config.yaml

@@ -0,0 +1,3 @@
+title: OpenAPI extensions
+description: Attach custom OpenAPI extensions to emitted declarations.
+playground: false

packages/samples/specs/param-decorators/sample-config.yaml

@@ -0,0 +1,3 @@
+title: Parameter decorators
+description: Apply decorators through reusable operation parameters.
+playground: false

packages/samples/specs/petstore/sample-config.yaml

@@ -0,0 +1,3 @@
+title: Extensible Pet Store
+description: Extend TypeSpec with a local decorator and custom project files.
+playground: false

packages/samples/specs/polymorphism/sample-config.yaml

@@ -0,0 +1,3 @@
+title: Polymorphic models
+description: Model inheritance and discriminated polymorphic responses.
+playground: false

packages/samples/specs/rest-metadata-emitter/sample-config.yaml

@@ -0,0 +1,3 @@
+title: REST metadata emitter
+description: Inspect REST metadata from a custom emitter.
+playground: false

packages/samples/specs/rest/petstore/sample-config.yaml

@@ -0,0 +1,3 @@
+title: REST Pet Store
+description: Define a resource-oriented Pet Store service.
+playground: false

packages/samples/specs/signatures/sample-config.yaml

@@ -0,0 +1,3 @@
+title: Operation signatures
+description: Compare operation declaration and template signatures.
+playground: false

packages/samples/specs/status-code-ranges/sample-config.yaml

@@ -0,0 +1,3 @@
+title: Status code ranges
+description: Describe HTTP responses covering status code ranges.
+playground: false

packages/samples/specs/string-template/sample-config.yaml

@@ -0,0 +1,3 @@
+title: String templates
+description: Construct values using TypeSpec string templates.
+playground: false

packages/samples/specs/tags/sample-config.yaml

@@ -0,0 +1,3 @@
+title: OpenAPI tags
+description: Group emitted operations with tags.
+playground: false

packages/samples/specs/todoApp/sample-config.yaml

@@ -0,0 +1,3 @@
+title: Todo application
+description: Define a complete HTTP API for a small todo application.
+playground: false

packages/samples/specs/use-versioned-lib/sample-config.yaml

@@ -0,0 +1,3 @@
+title: Versioned library
+description: Consume a library whose API evolves across versions.
+playground: false

packages/samples/specs/versioning/sample-config.yaml

@@ -0,0 +1,3 @@
+title: Advanced versioning
+description: Coordinate service and library versions across multiple files.
+playground: false

packages/samples/specs/visibility/sample-config.yaml

@@ -0,0 +1,3 @@
+title: Lifecycle visibility
+description: Control how model properties participate in lifecycle operations.
+playground: false

packages/samples/src/index.ts

@@ -1 +1,2 @@
+export * from "./sample-config.js";
 export * from "./sample-snapshot-testing.js";