✨ Operation IDs

Adds `@typespec/openapi` and defines Operation IDs for all operations.
Example: `GetFilm` instead of the default `film_read`.

package.json

@@ -42,6 +42,7 @@
 	"devDependencies": {
 		"@typespec/compiler": "~0.47.1",
 		"@typespec/http": "~0.47.0",
+		"@typespec/openapi": "^0.47.0",
 		"@typespec/openapi3": "~0.47.0",
 		"@typespec/prettier-plugin-typespec": "~0.47.0",
 		"husky": "^8.0.3",

src/films.tsp

@@ -9,6 +9,7 @@ namespace films {
 	 *
 	 * @param search Case-insensitive partial match on the `title` field.
 	 */
+	@OpenAPI.operationId("ListFilms")
 	op list(search: string): Film[];
 
 	@route("/{filmId}")
@@ -18,6 +19,7 @@ namespace films {
 		 *
 		 * @param filmId Numeric ID of the film to get.
 		 */
+		@OpenAPI.operationId("GetFilm")
 		op read(@path filmId: int32): Film;
 	}
 }

src/main.tsp

@@ -1,4 +1,5 @@
 import "@typespec/http";
+import "@typespec/openapi";
 
 import "./films.tsp";
 import "./people.tsp";

src/people.tsp

@@ -9,6 +9,7 @@ namespace people {
 	 *
 	 * @param search Case-insensitive partial match on the `name` field.
 	 */
+	@OpenAPI.operationId("ListPerson")
 	op list(search: string): Person[];
 
 	@route("/{personId}")
@@ -18,6 +19,7 @@ namespace people {
 		 *
 		 * @param personId Numeric ID of the person to get.
 		 */
+		@OpenAPI.operationId("GetPerson")
 		op read(@path personId: int32): Person;
 	}
 }

src/planets.tsp

@@ -9,6 +9,7 @@ namespace planets {
 	 *
 	 * @param search Case-insensitive partial match on the `name` field.
 	 */
+	@OpenAPI.operationId("ListPlanet")
 	op list(search: string): Planet[];
 
 	@route("/{planetId}")
@@ -18,6 +19,7 @@ namespace planets {
 		 *
 		 * @param planetId Numeric ID of the planet to get.
 		 */
+		@OpenAPI.operationId("GetPlanet")
 		op read(@path planetId: int32): Planet;
 	}
 }

src/root.tsp

@@ -4,8 +4,10 @@ namespace SWAPI;
 
 /** Gets the `Root` resource. */
 @route("/")
-@get
-op root(): Root;
+namespace root {
+	@OpenAPI.operationId("GetRoot")
+	op read(): Root;
+}
 
 /**
  * The Root resource provides information on all available resources within the

src/species.tsp

@@ -9,6 +9,7 @@ namespace species {
 	 *
 	 * @param search Case-insensitive partial match on the `name` field.
 	 */
+	@OpenAPI.operationId("ListSpecies")
 	op list(search: string): Species[];
 
 	@route("/{speciesId}")
@@ -18,6 +19,7 @@ namespace species {
 		 *
 		 * @param speciesId Numeric ID of the species to get.
 		 */
+		@OpenAPI.operationId("GetSpecies")
 		op read(@path speciesId: int32): Species;
 	}
 }

src/starships.tsp

@@ -9,6 +9,7 @@ namespace starships {
 	 *
 	 * @param search Case-insensitive partial match on the `name` and `model` fields.
 	 */
+	@OpenAPI.operationId("ListStarships")
 	op list(search: string): Starship[];
 
 	@route("/{starshipId}")
@@ -18,6 +19,7 @@ namespace starships {
 		 *
 		 * @param starshipId Numeric ID of the starship to get.
 		 */
+		@OpenAPI.operationId("GetStarship")
 		op read(@path starshipId: int32): Starship;
 	}
 }

src/vehicles.tsp

@@ -9,6 +9,7 @@ namespace vehicles {
 	 *
 	 * @param search Case-insensitive partial match on the `name` and `model` fields.
 	 */
+	@OpenAPI.operationId("ListVehicles")
 	op list(search: string): Vehicle[];
 
 	@route("/{vehicleId}")
@@ -18,6 +19,7 @@ namespace vehicles {
 		 *
 		 * @param vehicleId Numeric ID of the vehicle to get.
 		 */
+		@OpenAPI.operationId("GetVehicle")
 		op read(@path vehicleId: int32): Vehicle;
 	}
 }