apollographql / federation-hotchocolate

HotChocolate support for Apollo Federation
https://www.apollographql.com/docs/federation/
MIT License
16 stars 8 forks source link

Schema linting errors when using this package #58

Open damienpontifex opened 1 year ago

damienpontifex commented 1 year ago

I'm shifting over to use federation and directives with this package, but now getting linting errors (from Apollo Studio) within our pipeline. I believe they shouldn't exist and hence the issue here

I've bumped HotChocolate libraries from 13.5.0 to 13.6.1 and using 1.2.1 of this apollo package.

The schema file is generated by running rover subgraph introspect "http://localhost:5000/graphql" > "my-schema.graphql"

And then we do rover subgraph check <graph-ref>@<variant> --name my-service --schema my-schema.graphql

┌─────────┬─────────────────┬──────┬──────────────────────────────────────────────────────────┐
│  Level  │   Coordinate    │ Line │                       Description                        │
├─────────┼─────────────────┼──────┼──────────────────────────────────────────────────────────┤
│ WARNING │ Query._entities │ 29   │ Field names should use camelCase style.                  │
├─────────┼─────────────────┼──────┼──────────────────────────────────────────────────────────┤
│ WARNING │ Query._service  │ 28   │ Field names should use camelCase style.                  │
├─────────┼─────────────────┼──────┼──────────────────────────────────────────────────────────┤
│ ERROR   │ _Any            │ 167  │ Type names should use PascalCase style.                  │
├─────────┼─────────────────┼──────┼──────────────────────────────────────────────────────────┤
│ ERROR   │ _Entity         │ 95   │ Type names should use PascalCase style.                  │
├─────────┼─────────────────┼──────┼──────────────────────────────────────────────────────────┤
│ ERROR   │ _Service        │ 90   │ Type names should use PascalCase style.                  │
├─────────┼─────────────────┼──────┼──────────────────────────────────────────────────────────┤
│ WARNING │ @link           │ 131  │ Schema element @link is missing a description.           │
├─────────┼─────────────────┼──────┼──────────────────────────────────────────────────────────┤
│ WARNING │ Query._entities │ 29   │ Schema element Query._entities is missing a description. │
├─────────┼─────────────────┼──────┼──────────────────────────────────────────────────────────┤
│ WARNING │ Query._service  │ 28   │ Schema element Query._service is missing a description.  │
├─────────┼─────────────────┼──────┼──────────────────────────────────────────────────────────┤
│ WARNING │ _Service.sdl    │ 91   │ Schema element _Service.sdl is missing a description.    │
└─────────┴─────────────────┴──────┴──────────────────────────────────────────────────────────┘

Is this an issue in the schema rover is introspecting/generating? Or something about this package addition (reason I ask this as it wasn't failing prior when just utilising HotChocolate 13.5)?