Skip to content

entoas - Do not generate endpoints for skipped edges #574

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
swalkerhppr wants to merge 2 commits into
base: master
Choose a base branch
from
Open

entoas - Do not generate endpoints for skipped edges #574

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
185b78e
Skip edges with skip annotation. Skip fields with skip annotation. Do…
swalkerhppr Apr 15, 2024
18a8e05
Merge branch 'ent:master' into master
swalkerhppr Sep 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 37 additions & 14 deletions entoas/generator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,14 +70,20 @@ func schemas(g *gen.Graph, spec *ogen.Spec) error {
return fmt.Errorf("schema %q not found for edge %q on %q", e.Type.Name, e.Name, n.Name)
}
es = es.ToNamed(e.Type.Name).AsLocalRef()
if !e.Unique {
es = es.AsArray()
a, err := EdgeAnnotation(e)
if err != nil {
return fmt.Errorf("could not parse %q edge annotation for %q on %q", e.Type.Name, e.Name, n.Name)
}
if !a.Skip {
if !e.Unique {
es = es.AsArray()
}
addProperty(
spec.Components.Schemas[n.Name],
ogen.NewProperty().SetName(e.Name).SetSchema(es),
!e.Optional,
)
}
addProperty(
spec.Components.Schemas[n.Name],
ogen.NewProperty().SetName(e.Name).SetSchema(es),
!e.Optional,
)
}
}
// If the SimpleModels feature is enabled to not generate a schema per response.
Expand Down Expand Up @@ -110,14 +116,20 @@ func schemas(g *gen.Graph, spec *ogen.Spec) error {
return fmt.Errorf("schema %q not found for edge %q on %q", vn, e.Name, n)
}
es = es.ToNamed(vn).AsLocalRef()
if !e.Unique {
es = es.AsArray()
a, err := EdgeAnnotation(e)
if err != nil {
return fmt.Errorf("could not parse %q edge annotation for %q on %q", e.Name, e.Name, n)
}
if !a.Skip {
if !e.Unique {
es = es.AsArray()
}
addProperty(
spec.Components.Schemas[n],
ogen.NewProperty().SetName(e.Name).SetSchema(es),
!e.Optional,
)
}
addProperty(
spec.Components.Schemas[n],
ogen.NewProperty().SetName(e.Name).SetSchema(es),
!e.Optional,
)
}
}
}
Expand Down Expand Up @@ -662,6 +674,10 @@ func EdgeOperations(e *gen.Edge) ([]Operation, error) {
if err := ant.Decode(e.Annotations[ant.Name()]); err != nil {
return nil, err
}
// Skipped edges get no operations
if ant.Skip {
return nil, nil
}
var ops []Operation
m := make(map[Operation]OperationConfig)
if e.Unique {
Expand Down Expand Up @@ -724,6 +740,13 @@ func reqBody(n *gen.Type, op Operation, allowClientUUIDs bool) (*ogen.RequestBod
if err != nil {
return nil, err
}
a, err := EdgeAnnotation(e)
if err != nil {
return nil, err
}
if a.ReadOnly || a.Skip {
continue
}
if !e.Unique {
s = s.AsArray()
}
Expand Down