Merge branch 'main' into generate-all-acs

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/blueprint",
-  "version": "0.15.2",
+  "version": "0.16.1",
   "description": "Build tools for the Seam API using this blueprint.",
   "type": "module",
   "main": "index.js",

src/lib/blueprint.ts

@@ -26,6 +26,7 @@ export interface Blueprint {
 
 export interface Route {
   path: string
+  name: string
   namespace: Namespace | null
   endpoints: Endpoint[]
   subroutes: Route[]
@@ -44,6 +45,7 @@ export interface Namespace {
 export interface Endpoint {
   title: string
   path: string
+  name: string
   description: string
   isUndocumented: boolean
   isDeprecated: boolean
@@ -304,9 +306,14 @@ const createRoute = async (
 ): Promise<Route> => {
   const pathParts = path.split('/')
   const routePath = `/${pathParts.slice(1, -1).join('/')}`
+  const name = pathParts.at(-2)
+  if (name == null) {
+    throw new Error(`Could not resolve name for route at ${path}`)
+  }
 
   return {
     path: routePath,
+    name,
     namespace: { path: `/${pathParts[1]}` },
     endpoints: await createEndpoints(path, pathItem, context),
     subroutes: [],
@@ -349,6 +356,11 @@ const createEndpoint = async (
   const pathParts = path.split('/')
   const endpointPath = `/${pathParts.slice(1).join('/')}`
 
+  const name = pathParts.at(-1)
+  if (name == null) {
+    throw new Error(`Could not resolve name for endpoint at ${path}`)
+  }
+
   const parsedOperation = OpenapiOperationSchema.parse(operation)
 
   const title = parsedOperation['x-title']
@@ -363,8 +375,9 @@ const createEndpoint = async (
 
   const request = createRequest(methods, operation)
 
-  const endpoint = {
+  const endpoint: Omit<Endpoint, 'codeSamples'> = {
     title,
+    name,
     path: endpointPath,
     description,
     isUndocumented,

test/snapshots/blueprint.test.ts.md

@@ -129,6 +129,7 @@ Generated by [AVA](https://avajs.dev).
               description: '',
               isDeprecated: false,
               isUndocumented: false,
+              name: 'get',
               path: '/foos/get',
               request: {
                 methods: [
@@ -210,6 +211,7 @@ Generated by [AVA](https://avajs.dev).
               description: '',
               isDeprecated: false,
               isUndocumented: false,
+              name: 'get',
               path: '/foos/get',
               request: {
                 methods: [
@@ -291,6 +293,7 @@ Generated by [AVA](https://avajs.dev).
               description: '',
               isDeprecated: false,
               isUndocumented: false,
+              name: 'list',
               path: '/foos/list',
               request: {
                 methods: [
@@ -372,6 +375,7 @@ Generated by [AVA](https://avajs.dev).
               description: '',
               isDeprecated: false,
               isUndocumented: false,
+              name: 'list',
               path: '/foos/list',
               request: {
                 methods: [
@@ -390,6 +394,7 @@ Generated by [AVA](https://avajs.dev).
               title: 'List foos',
             },
           ],
+          name: 'foos',
           namespace: {
             path: '/foos',
           },
@@ -535,6 +540,7 @@ Generated by [AVA](https://avajs.dev).
               description: '',
               isDeprecated: false,
               isUndocumented: false,
+              name: 'get',
               path: '/foos/get',
               request: {
                 methods: [
@@ -626,6 +632,7 @@ Generated by [AVA](https://avajs.dev).
               description: '',
               isDeprecated: false,
               isUndocumented: false,
+              name: 'get',
               path: '/foos/get',
               request: {
                 methods: [
@@ -717,6 +724,7 @@ Generated by [AVA](https://avajs.dev).
               description: '',
               isDeprecated: false,
               isUndocumented: false,
+              name: 'list',
               path: '/foos/list',
               request: {
                 methods: [
@@ -808,6 +816,7 @@ Generated by [AVA](https://avajs.dev).
               description: '',
               isDeprecated: false,
               isUndocumented: false,
+              name: 'list',
               path: '/foos/list',
               request: {
                 methods: [
@@ -826,6 +835,7 @@ Generated by [AVA](https://avajs.dev).
               title: 'List foos',
             },
           ],
+          name: 'foos',
           namespace: {
             path: '/foos',
           },