HydrologicEngineeringCenter / HydrologicEngineeringCenter/cwms-data-api-client

Add method to check whether the client has write access

Open
#116 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
8
Forks
12
Avg merge
2h 44m
Merged PRs (30d)
3

Description

Currently we test by checking a 401 error code with a dummy post to the catalog endpoint. From Mike Neilson:

...FYI the swagger-docs output will include security schemas if it can write, that’s better than making a request and it just pollutes the logs (the access log is one line, the failed request is like 10.)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the client code that checks write access with a dummy POST to the catalog endpoint and review how the 401 response is handled. Inspect the swagger-docs security schemas as the alternative signal, then add the access-check method and verify that it avoids the extra request and log pollution.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.