geniespec 0.1.2.dev6__tar.gz → 0.1.2.dev7__tar.gz

{geniespec-0.1.2.dev6 → geniespec-0.1.2.dev7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geniespec
-Version: 0.1.2.dev6
+Version: 0.1.2.dev7
 Summary: Generate API code from an api.yaml spec
 License-Expression: MIT
 Requires-Dist: jinja2>=3.1.6
@@ -117,6 +117,12 @@ resources:
 
 `python-server` passes the transition fields to kiba-core's `route`, whose `OpenApiSchemaGenerator` documents every route with an `operationId` (and skips the rest); `extensions` reach `OpenApiExtension`s as `metadata['extensions']`. Field descriptions become pydantic `Field(description=...)`, so they show up in the request and response schemas. Each `operationId` must be unique, so a transition that generates more than one route (for example `GET` on a resource with unique attributes) can't set one. `typescript-client` ignores these fields.
 
+## Overrides
+
+`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}`).
+
 # Development
 
 ```

{geniespec-0.1.2.dev6 → geniespec-0.1.2.dev7}/README.md

@@ -103,6 +103,12 @@ resources:
 
 `python-server` passes the transition fields to kiba-core's `route`, whose `OpenApiSchemaGenerator` documents every route with an `operationId` (and skips the rest); `extensions` reach `OpenApiExtension`s as `metadata['extensions']`. Field descriptions become pydantic `Field(description=...)`, so they show up in the request and response schemas. Each `operationId` must be unique, so a transition that generates more than one route (for example `GET` on a resource with unique attributes) can't set one. `typescript-client` ignores these fields.
 
+## Overrides
+
+`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}`).
+
 # Development
 
 ```

{geniespec-0.1.2.dev6 → geniespec-0.1.2.dev7}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "geniespec"
-version = "0.1.2.dev6"
+version = "0.1.2.dev7"
 description = "Generate API code from an api.yaml spec"
 readme = "README.md"
 license = "MIT"

{geniespec-0.1.2.dev6 → geniespec-0.1.2.dev7}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "geniespec"
-version = "0.1.2.dev6"
+version = "0.1.2.dev7"
 description = "Generate API code from an api.yaml spec"
 readme = "README.md"
 license = "MIT"

{geniespec-0.1.2.dev6 → geniespec-0.1.2.dev7}/src/geniespec/api_schema.yaml

@@ -208,6 +208,12 @@ definitions:
         type: array
         items:
           type: string
+      overrides:
+        type: object
+        additionalProperties: false
+        properties:
+          shouldPrefixParentName:
+            type: boolean
   BaseTransition:
     type: object
     additionalProperties: false

{geniespec-0.1.2.dev6 → geniespec-0.1.2.dev7}/src/geniespec/genie.py

@@ -266,7 +266,7 @@ class Renderer:
 
     @staticmethod
     def _resource_full_name(resource: Resource, name: str) -> str:
-        return f'{resource.parentResource or ""}{name}'
+        return f'{resource.parentResource or ""}{name}' if resource.overrides.shouldPrefixParentName else name
 
     def _resource_to_renderable_resource(self, resource: Resource, knownTypeNames: dict[str, str]) -> RenderableResource:
         attributes = [self._attribute_to_renderable_attribute(attribute=attribute, knownTypeNames=knownTypeNames) for attribute in resource.attributes]
@@ -298,7 +298,9 @@ class Renderer:
 
     @staticmethod
     def _relative_name(name: RenderableString, anchor: RenderableResource | None) -> RenderableString:
-        return RenderableString(string=name.string[len(anchor.singleName.string) :]) if anchor is not None else name
+        if anchor is None or name.string[: len(anchor.singleName.string)] != anchor.singleName.string:
+            return name
+        return RenderableString(string=name.string[len(anchor.singleName.string) :])
 
     def _resource_component(self, resource: RenderableResource, attribute: RenderableAttribute | None, anchor: RenderableResource | None) -> ResourceEndpointComponent:
         return ResourceEndpointComponent(

{geniespec-0.1.2.dev6 → geniespec-0.1.2.dev7}/src/geniespec/types.py

@@ -140,6 +140,10 @@ class RootTransition(BaseTransition):
     pass
 
 
+class ResourceOverrides(BaseModel):
+    shouldPrefixParentName: bool = True
+
+
 class Resource(BaseModel):
     singleName: str
     collectionName: str
@@ -147,6 +151,7 @@ class Resource(BaseModel):
     attributes: list[Attribute] = []
     transitions: list[Transition] = []
     accessibleFrom: list[str] = []
+    overrides: ResourceOverrides = ResourceOverrides()
 
     @property
     def primaryAttribute(self) -> Attribute | None:  # noqa: N802