Browse Source

slight formatting change to the pod

Issue #11
master
Blaine Motsinger 1 year ago
parent
commit
2e63329c1d
1 changed files with 8 additions and 2 deletions
  1. 8
    2
      lib/Rend/Map/API/Points.pm

+ 8
- 2
lib/Rend/Map/API/Points.pm View File

@@ -263,9 +263,15 @@ The Allow header indicating POST and OPTIONS are available methods.

This method stores a new point into the db table.

The api-key header containing a value matching what's stored in the user_keys table, is required to post. 403 'unauthorized' will be returned if the api-key is missing or doesn't match.
The api-key header containing a value matching what's stored in the user_keys table, is required to post.

After authentication is successful, a JSON payload containing key value pairs for 'point' and 'description', are required. 400 'bad request', with string indicating 'point, description, and map_id values are required' will be returned if the payload is missing either. 409 'conflict', with string indicating 'map_id $map_id is not an existing map' will be returned if the supplied map_id doesn't exist in the db.
403 'unauthorized' will be returned if the api-key is missing or doesn't match.

After authentication is successful, a JSON payload containing key value pairs for 'point' and 'description', are required.

400 'bad request', with string indicating 'point, description, and map_id values are required' will be returned if the payload is missing either.

409 'conflict', with string indicating 'map_id $map_id is not an existing map' will be returned if the supplied map_id doesn't exist in the db.

After verifying point and description, the new point will be inserted into the table, and 200 'OK', with string indicating 'point was inserted correctly' will be returned.


Loading…
Cancel
Save