Tripletex / Tripletex/tripletex-api2

[Docs] Missing indication on required field in project-endpoint

Open
#23 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
49
Forks
47
Avg merge
1h 1m
Merged PRs (30d)
1

Description

When making a post-request to the /project-endpoint the docs says that only first- and lastname of the project manager is required. When executing the request you get a missing parameter error saying that the endpoint requires projectmanager.id.

Docs should be updated...

Contributor guide

No contributing guide indexed for this repository

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

Start with the API documentation for POST /project-endpoint and inspect how the project manager fields are described. Update the required-field indication to include projectmanager.id, and verify that the documentation matches the missing-parameter error reported when executing the request.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.