What to do when you want to pass a polygon with `OBS_GetBoundariesByGeometry(polygon geometry, geometry_id text)`?

[csobier]

@talos , can you help me clarify the docs around this?

• OBS function: OBS_GetPointsByGeometry(polygon geometry, geometry_id text)
• Errors: If a geometry other than a point is passed as the first argument, an error is thrown: Invalid geometry type (ST_Point), expecting 'ST_MultiPolygon' or 'ST_Polygon'

Is the error message wrong, does it need more information? Or should the name of the function (and the first argument in the table), be changed to "point", not "polygon"? I'm not sure I understand what needs to be clarified, so I wanted to start the conversation.

@ztephm for awareness, since she stumbled upon this scenario today.

[talos]

I think @ztephm was referring to docs for OBS_GetBoundariesByGeometry.

That function can take either a point or a polygon. So its first argument should just be geom geometry instead of polygon geometry, and the first error If a geometry other than a point... should be removed.

[ztephm]

• Yes, the function that we are talking about is correct in the issue title: OBS_GetBoundariesByGeometry but the one in the issue description is: OBS_GetPointsByGeometry - instead of "Points" that should also refer to "Boundaries": OBS_GetBoundariesByGeometry

• Yes, what needs to change about that function in docs is the first parameter. Right now it looks like this in docs: OBS_GetBoundariesByGeometry(polygon geometry, geometry_id text)

  but it should be changed to this per John's comment: OBS_GetBoundariesByGeometry(geom geometry, geometry_id text)

• and the first point in this error section should be removed as John mentioned.

[csobier]

Ok, sorry (I copied and pasted wrong, overload moment). I'll create a PR with the fixes. Thank you!