search

PolicyEngine / policyengine-app

PolicyEngine's free web app for computing the impact of public policy.
GNU Affero General Public License v3.0
35 stars 89 forks source link

Add token fetching information to API documentation page #1774

Closed anth-volk closed 2 weeks ago

anth-volk commented 2 weeks ago

Description

Fixes #1773.

Changes

This PR adds a section to describe the process of fetching an authentication token for the household API. It creates a new component, APIEndpointStatic, that is similar to APIEndpoint, but does not execute a fetch request. It also adds relevant information about the process.

I was unsure whether the section should be placed above or below the policy outcomes calculation section. I placed it under, but please feel free to move it in review.

Screenshots

A video of the component in action is available below. https://github.com/PolicyEngine/policyengine-app/assets/14987227/6fe68ebb-61d5-42a8-a3c8-8c9147448578

Tests

N/A

codecov[bot] commented 2 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 20.67%. Comparing base (2913358) to head (d3f6cfc). Report is 15 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #1774 +/- ## ========================================== + Coverage 18.67% 20.67% +2.00% ========================================== Files 168 169 +1 Lines 6206 6234 +28 Branches 1952 1993 +41 ========================================== + Hits 1159 1289 +130 + Misses 4936 4843 -93 + Partials 111 102 -9 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.