Skip to content
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.

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

Empty operationId found for several paths #44

Open
ghobona opened this issue Oct 28, 2021 · 2 comments
Open

Empty operationId found for several paths #44

ghobona opened this issue Oct 28, 2021 · 2 comments
Assignees

Comments

@ghobona
Copy link
Contributor

ghobona commented Oct 28, 2021

When compiling version 0.0.6 of the DGGS API Definition document, OpenAPITools Generator is reporting a warning that:

Empty operationId found for path: get /. Renamed to auto-generated operationId: rootGet
Empty operationId found for path: get /api. Renamed to auto-generated operationId: apiGet
Empty operationId found for path: get /conformance. Renamed to auto-generated operationId: conformanceGet
Empty operationId found for path: get /collections. Renamed to auto-generated operationId: collectionsGet
Empty operationId found for path: get /dggs. Renamed to auto-generated operationId: dggsGet
Empty operationId found for path: get /dggs/{dggsRSID}. Renamed to auto-generated operationId: dggsDggsRSIDGet
Empty operationId found for path: get /dggs/{dggsRSID}/zones. Renamed to auto-generated operationId: dggsDggsRSIDZonesGet
Empty operationId found for path: get /dggs/{dggsRSID}/zone/{ZonalID}. Renamed to auto-generated operationId: dggsDggsRSIDZoneZonalIDGet
Empty operationId found for path: get /dggs/{dggsRSID}/zone/{ZonalID}/distance. Renamed to auto-generated operationId: dggsDggsRSIDZoneZonalIDDistanceGet
Empty operationId found for path: get /collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/distance. Renamed to auto-generated operationId: collectionsCollectionIdDggsDggsRSIDZoneZonalIDDistanceGet
Empty operationId found for path: get /dggs/{dggsRSID}/zone/{ZonalID}/buffer. Renamed to auto-generated operationId: dggsDggsRSIDZoneZonalIDBufferGet
Empty operationId found for path: get /dggs/{dggsRSID}/zone/{ZonalID}/difference. Renamed to auto-generated operationId: dggsDggsRSIDZoneZonalIDDifferenceGet
Empty operationId found for path: get /dggs/{dggsRSID}/zone/{ZonalID}/intersection. Renamed to auto-generated operationId: dggsDggsRSIDZoneZonalIDIntersectionGet
Empty operationId found for path: get /dggs/{dggsRSID}/zone/{ZonalID}/symDifference. Renamed to auto-generated operationId: dggsDggsRSIDZoneZonalIDSymDifferenceGet
Empty operationId found for path: get /dggs/{dggsRSID}/zone/{ZonalID}/union. Renamed to auto-generated operationId: dggsDggsRSIDZoneZonalIDUnionGet
Empty operationId found for path: get /dggs/{dggsRSID}/zone/{ZonalID}/child. Renamed to auto-generated operationId: dggsDggsRSIDZoneZonalIDChildGet
Empty operationId found for path: get /dggs/{dggsRSID}/zone/{ZonalID}/parent. Renamed to auto-generated operationId: dggsDggsRSIDZoneZonalIDParentGet
Empty operationId found for path: get /dggs/{dggsRSID}/zone/{ZonalID}/sibling. Renamed to auto-generated operationId: dggsDggsRSIDZoneZonalIDSiblingGet
Empty operationId found for path: get /collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/buffer. Renamed to auto-generated operationId: collectionsCollectionIdDggsDggsRSIDZoneZonalIDBufferGet
Empty operationId found for path: get /collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/difference. Renamed to auto-generated operationId: collectionsCollectionIdDggsDggsRSIDZoneZonalIDDifferenceGet
Empty operationId found for path: get /collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/intersection. Renamed to auto-generated operationId: collectionsCollectionIdDggsDggsRSIDZoneZonalIDIntersectionGet
Empty operationId found for path: get /collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/symDifference. Renamed to auto-generated operationId: collectionsCollectionIdDggsDggsRSIDZoneZonalIDSymDifferenceGet
Empty operationId found for path: get /collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/union. Renamed to auto-generated operationId: collectionsCollectionIdDggsDggsRSIDZoneZonalIDUnionGet
Empty operationId found for path: get /collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/child. Renamed to auto-generated operationId: collectionsCollectionIdDggsDggsRSIDZoneZonalIDChildGet
Empty operationId found for path: get /collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/parent. Renamed to auto-generated operationId: collectionsCollectionIdDggsDggsRSIDZoneZonalIDParentGet
Empty operationId found for path: get /collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/sibling. Renamed to auto-generated operationId: collectionsCollectionIdDggsDggsRSIDZoneZonalIDSiblingGet
Empty operationId found for path: get /dggs/{dggsRSID}/zone/{ZonalID}/relativePosition. Renamed to auto-generated operationId: dggsDggsRSIDZoneZonalIDRelativePositionGet
Empty operationId found for path: get /dggs/{dggsRSID}/zone/{ZonalID}/contains. Renamed to auto-generated operationId: dggsDggsRSIDZoneZonalIDContainsGet
Empty operationId found for path: get /dggs/{dggsRSID}/zone/{ZonalID}/crosses. Renamed to auto-generated operationId: dggsDggsRSIDZoneZonalIDCrossesGet
Empty operationId found for path: get /dggs/{dggsRSID}/zone/{ZonalID}/disjoint. Renamed to auto-generated operationId: dggsDggsRSIDZoneZonalIDDisjointGet
Empty operationId found for path: get /dggs/{dggsRSID}/zone/{ZonalID}/equals. Renamed to auto-generated operationId: dggsDggsRSIDZoneZonalIDEqualsGet
Empty operationId found for path: get /dggs/{dggsRSID}/zone/{ZonalID}/intersects. Renamed to auto-generated operationId: dggsDggsRSIDZoneZonalIDIntersectsGet
Empty operationId found for path: get /dggs/{dggsRSID}/zone/{ZonalID}/overlaps. Renamed to auto-generated operationId: dggsDggsRSIDZoneZonalIDOverlapsGet
Empty operationId found for path: get /dggs/{dggsRSID}/zone/{ZonalID}/touches. Renamed to auto-generated operationId: dggsDggsRSIDZoneZonalIDTouchesGet
Empty operationId found for path: get /dggs/{dggsRSID}/zone/{ZonalID}/within. Renamed to auto-generated operationId: dggsDggsRSIDZoneZonalIDWithinGet
Empty operationId found for path: get /dggs/{dggsRSID}/zone/{ZonalID}/withinDistance. Renamed to auto-generated operationId: dggsDggsRSIDZoneZonalIDWithinDistanceGet
Empty operationId found for path: get /dggs/{dggsRSID}/zone/{ZonalID}/childOf. Renamed to auto-generated operationId: dggsDggsRSIDZoneZonalIDChildOfGet
Empty operationId found for path: get /dggs/{dggsRSID}/zone/{ZonalID}/parentOf. Renamed to auto-generated operationId: dggsDggsRSIDZoneZonalIDParentOfGet
Empty operationId found for path: get /dggs/{dggsRSID}/zone/{ZonalID}/siblingOf. Renamed to auto-generated operationId: dggsDggsRSIDZoneZonalIDSiblingOfGet
Empty operationId found for path: get /collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/relativePosition. Renamed to auto-generated operationId: collectionsCollectionIdDggsDggsRSIDZoneZonalIDRelativePositionGet
Empty operationId found for path: get /collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/contains. Renamed to auto-generated operationId: collectionsCollectionIdDggsDggsRSIDZoneZonalIDContainsGet
Empty operationId found for path: get /collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/crosses. Renamed to auto-generated operationId: collectionsCollectionIdDggsDggsRSIDZoneZonalIDCrossesGet
Empty operationId found for path: get /collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/disjoint. Renamed to auto-generated operationId: collectionsCollectionIdDggsDggsRSIDZoneZonalIDDisjointGet
Empty operationId found for path: get /collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/equals. Renamed to auto-generated operationId: collectionsCollectionIdDggsDggsRSIDZoneZonalIDEqualsGet
Empty operationId found for path: get /collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/intersects. Renamed to auto-generated operationId: collectionsCollectionIdDggsDggsRSIDZoneZonalIDIntersectsGet
Empty operationId found for path: get /collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/overlaps. Renamed to auto-generated operationId: collectionsCollectionIdDggsDggsRSIDZoneZonalIDOverlapsGet
Empty operationId found for path: get /collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/touches. Renamed to auto-generated operationId: collectionsCollectionIdDggsDggsRSIDZoneZonalIDTouchesGet
Empty operationId found for path: get /collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/within. Renamed to auto-generated operationId: collectionsCollectionIdDggsDggsRSIDZoneZonalIDWithinGet
Empty operationId found for path: get /collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/withinDistance. Renamed to auto-generated operationId: collectionsCollectionIdDggsDggsRSIDZoneZonalIDWithinDistanceGet
Empty operationId found for path: get /collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/childOf. Renamed to auto-generated operationId: collectionsCollectionIdDggsDggsRSIDZoneZonalIDChildOfGet
Empty operationId found for path: get /collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/parentOf. Renamed to auto-generated operationId: collectionsCollectionIdDggsDggsRSIDZoneZonalIDParentOfGet
Empty operationId found for path: get /collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/siblingOf. Renamed to auto-generated operationId: collectionsCollectionIdDggsDggsRSIDZoneZonalIDSiblingOfGet
Empty operationId found for path: get /dggs/{dggsRSID}/zone/{ZonalID}/relate. Renamed to auto-generated operationId: dggsDggsRSIDZoneZonalIDRelateGet
Empty operationId found for path: get /dggs/{dggsRSID}/zone/{ZonalID}/relatePosition. Renamed to auto-generated operationId: dggsDggsRSIDZoneZonalIDRelatePositionGet
Empty operationId found for path: get /collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/relate. Renamed to auto-generated operationId: collectionsCollectionIdDggsDggsRSIDZoneZonalIDRelateGet
Empty operationId found for path: get /collections/{collectionId}/dggs/{dggsRSID}/zone/{ZonalID}/relatePosition. Renamed to auto-generated operationId: collectionsCollectionIdDggsDggsRSIDZoneZonalIDRelatePositionGet
@ghobona ghobona changed the title Empty operationId found for several paths DGGS API: Empty operationId found for several paths Oct 28, 2021
@ghobona ghobona changed the title DGGS API: Empty operationId found for several paths Empty operationId found for several paths Oct 28, 2021
@ghobona
Copy link
Contributor Author

ghobona commented Oct 28, 2021

The next version of the API Definition document will need to include operationId elements.

Here are the ones from the OGC API - Features example API definition documents:

  • operationId for / is getLandingPage
  • operationId for /conformance is getConformanceDeclaration
  • operationId for /collections is getCollections

@ghobona ghobona transferred this issue from opengeospatial/ogcapi-code-sprint-2021-10 Nov 2, 2021
@jerstlouis
Copy link
Member

See also approach in Tiles about potentially relating an operationId to particular specification requirements operation using e.g. a suffix, since operationId are unique across an API and may be used more than once, e.g. for different collections

opengeospatial/ogcapi-tiles#101 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants