geniespec 0.1.2.dev8__tar.gz → 0.1.2.dev11__tar.gz

{geniespec-0.1.2.dev8 → geniespec-0.1.2.dev11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geniespec
-Version: 0.1.2.dev8
+Version: 0.1.2.dev11
 Summary: Generate API code from an api.yaml spec
 License-Expression: MIT
 Requires-Dist: jinja2>=3.1.6
@@ -124,6 +124,7 @@ resources:
 `overrides` keep an API that existed before genie working the same way once it moves to genie. They are meant to be dropped in the next major version of that API.
 
 - `shouldPrefixParentName: false` on a child resource names it without its parent's name: `Agent` under `User` stays `Agent` (not `UserAgent`), so its primary attribute is `agent-id` rather than `user-agent-id` and its fields keep their names. Its path is unchanged (`/users/{userId}/agents/{agentId}`).
+- `responseFieldName` on a `GET`, `LIST`, `CREATE` or `UPDATE` transition renames the field its response puts the resource in (for example `memories` instead of `agentMemories`). Custom transitions name it with `responseField`.
 
 # Development
 

{geniespec-0.1.2.dev8 → geniespec-0.1.2.dev11}/README.md

@@ -110,6 +110,7 @@ resources:
 `overrides` keep an API that existed before genie working the same way once it moves to genie. They are meant to be dropped in the next major version of that API.
 
 - `shouldPrefixParentName: false` on a child resource names it without its parent's name: `Agent` under `User` stays `Agent` (not `UserAgent`), so its primary attribute is `agent-id` rather than `user-agent-id` and its fields keep their names. Its path is unchanged (`/users/{userId}/agents/{agentId}`).
+- `responseFieldName` on a `GET`, `LIST`, `CREATE` or `UPDATE` transition renames the field its response puts the resource in (for example `memories` instead of `agentMemories`). Custom transitions name it with `responseField`.
 
 # Development
 

{geniespec-0.1.2.dev8 → geniespec-0.1.2.dev11}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "geniespec"
-version = "0.1.2.dev8"
+version = "0.1.2.dev11"
 description = "Generate API code from an api.yaml spec"
 readme = "README.md"
 license = "MIT"
@@ -21,7 +21,7 @@ repository = "https://github.com/kibalabs/genie"
 
 [dependency-groups]
 dev = [
-    "kiba-build==0.1.11.dev15",
+    "kiba-build==0.1.11.dev24",
     "kiba-core[core-api,requester]>=0.5.3.dev87,<0.5.4",
 ]
 
@@ -31,7 +31,3 @@ build-backend = "uv_build"
 
 [tool.pytest.ini_options]
 pythonpath = ["src"]
-
-[tool.bumpversion]
-search = 'version = "{current_version}"'
-replace = 'version = "{new_version}"'

{geniespec-0.1.2.dev8 → geniespec-0.1.2.dev11}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "geniespec"
-version = "0.1.2.dev8"
+version = "0.1.2.dev11"
 description = "Generate API code from an api.yaml spec"
 readme = "README.md"
 license = "MIT"
@@ -21,7 +21,7 @@ repository = "https://github.com/kibalabs/genie"
 
 [dependency-groups]
 dev = [
-    "kiba-build==0.1.11.dev15",
+    "kiba-build==0.1.11.dev24",
     "kiba-core[core-api,requester]>=0.5.3.dev87,<0.5.4",
 ]
 
@@ -31,8 +31,3 @@ build-backend = "uv_build"
 
 [tool.pytest.ini_options]
 pythonpath = ["src"]
-
-# NOTE(krishan711): without this, bumping the version also rewrites dependency pins that contain it (e.g. 0.1.1 inside kiba-build==0.1.11.dev15)
-[tool.bumpversion]
-search = "version = \"{current_version}\""
-replace = "version = \"{new_version}\""

{geniespec-0.1.2.dev8 → geniespec-0.1.2.dev11}/src/geniespec/api_schema.yaml

@@ -263,6 +263,8 @@ definitions:
           type: string
       extensions:
         type: object
+      overrides:
+        $ref: '#/definitions/TransitionOverrides'
   Transition:
     type: object
     additionalProperties: false
@@ -319,6 +321,15 @@ definitions:
           type: string
       extensions:
         type: object
+      overrides:
+        $ref: '#/definitions/TransitionOverrides'
+  TransitionOverrides:
+    type: object
+    additionalProperties: false
+    properties:
+      responseFieldName:
+        type: string
+        pattern: '^[a-z][A-Za-z0-9-]*$'
   RootTransition:
     type: object
     allOf:

{geniespec-0.1.2.dev8 → geniespec-0.1.2.dev11}/src/geniespec/genie.py

@@ -264,6 +264,15 @@ class Renderer:
     def _operation_documentation(transition: BaseTransition) -> dict[str, object]:
         return {'operationId': transition.operationId, 'summary': transition.summary, 'description': transition.description, 'tags': transition.tags, 'extensions': transition.extensions}
 
+    def _with_transition_fields(self, operation: RenderableOperation, transition: BaseTransition, isStandard: bool) -> RenderableOperation:
+        update = self._operation_documentation(transition=transition)
+        responseFieldName = transition.overrides.responseFieldName
+        if responseFieldName is not None:
+            if not isStandard or not operation.responseFields:
+                raise SemanticValidationException(message=f'Only GET, LIST, CREATE and UPDATE transitions can override responseFieldName: {transition.action}')
+            update['responseFields'] = [field.model_copy(update={'name': RenderableString.from_kebab_case_string(string=responseFieldName)}) for field in operation.responseFields]
+        return operation.model_copy(update=update)
+
     @staticmethod
     def _resource_full_name(resource: Resource, name: str) -> str:
         return f'{resource.parentResource or ""}{name}' if resource.overrides.shouldPrefixParentName else name
@@ -462,13 +471,17 @@ class Renderer:
         if resourceErrors:
             raise SemanticValidationException(message='\n'.join(resourceErrors))
         renderableOperations = [
-            self._action_operation(
+            self._with_transition_fields(
+                operation=self._action_operation(
+                    transition=transition,
+                    endpoint=RenderableEndpoint(components=[ActionEndpointComponent(actionName=RenderableString.from_separated_string(string=transition.action, separator='-'))]),
+                    knownTypeNames=knownTypeNames,
+                    defaultAuthentication=api.defaultAuthentication,
+                    defaultRateLimit=api.defaultRateLimit,
+                ),
                 transition=transition,
-                endpoint=RenderableEndpoint(components=[ActionEndpointComponent(actionName=RenderableString.from_separated_string(string=transition.action, separator='-'))]),
-                knownTypeNames=knownTypeNames,
-                defaultAuthentication=api.defaultAuthentication,
-                defaultRateLimit=api.defaultRateLimit,
-            ).model_copy(update=self._operation_documentation(transition=transition))
+                isStandard=False,
+            )
             for transition in api.transitions
         ]
         renderableExceptions = [
@@ -574,7 +587,8 @@ class Renderer:
                     for endpoint in customEndpoints:
                         customEndpoint = RenderableEndpoint(components=[*endpoint.components, ActionEndpointComponent(actionName=RenderableString.from_separated_string(string=transition.action, separator='-'))])
                         renderableApi.operations.append(self._action_operation(transition=transition, endpoint=customEndpoint, knownTypeNames=knownTypeNames, defaultAuthentication=api.defaultAuthentication, defaultRateLimit=api.defaultRateLimit, isIndirectAction=transition.isIndirectAction))
-                renderableApi.operations[operationCount:] = [operation.model_copy(update=self._operation_documentation(transition=transition)) for operation in renderableApi.operations[operationCount:]]
+                isStandard = transition.action.upper() in {'CREATE', 'UPDATE', 'GET', 'LIST'}
+                renderableApi.operations[operationCount:] = [self._with_transition_fields(operation=operation, transition=transition, isStandard=isStandard) for operation in renderableApi.operations[operationCount:]]
                 if len(renderableApi.operations) == operationCount:
                     uncoveredTransitions.append(f'{renderableResource.singleName.pascalCaseString} {transition.action}')
         if uncoveredTransitions:

{geniespec-0.1.2.dev8 → geniespec-0.1.2.dev11}/src/geniespec/types.py

@@ -117,6 +117,10 @@ class RequestField(BaseModel):
     description: str | None = None
 
 
+class TransitionOverrides(BaseModel):
+    responseFieldName: str | None = None
+
+
 class BaseTransition(BaseModel):
     action: str
     method: str | None = None
@@ -130,6 +134,7 @@ class BaseTransition(BaseModel):
     description: str | None = None
     tags: list[str] = []
     extensions: dict[str, pydantic.JsonValue] = {}
+    overrides: TransitionOverrides = TransitionOverrides()
 
 
 class Transition(BaseTransition):