algorand / algorand/go-algorand

Header key/value pair missing in definition files - user experience issue

Offen
#1,524 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
FDE
Vorherrschende Sprache
Go
Sterne
1.4k
Forks
537
Ø Merge
1 T. 7 Std.
Gemergte PRs (30 T.)
18

Beschreibung

Suggesting Header key/value name pairs defined in the oas files for each end point. Right now the user needs to edit every end point at copy and paste the name of the name of the key or set up variables when importing to postman. Providing this in our definition files, for the key name for the token of X-Algo-API-Token , a new Algorand REST API developer would not need to look that up in the docs, and would make it easier to use. Defaulting the placeholder value to the sandbox would be a bonus, if possible. Example images attached. The image without the key/value pair is how it appears after import, the image with, is after editing each end point with the key/value needed in the header. I am creating a `run in postman` widget in our docs and this would also facilitate reducing maintenance efforts for devrel.

Repro steps:

Clone repository
Start postman app.
Hit the import button in the top left hand corner and upload algod.oas2.yml from your local clone.
See images below that show missing token key/value pairs on the lower image.

![Header-key-value-defaults](https://user-images.githubusercontent.com/4959925/93610992-b7602500-f99b-11ea-968d-f0c43f16e26c.png)
![Header-key-value-empty](https://user-images.githubusercontent.com/4959925/93610994-b7f8bb80-f99b-11ea-8a29-005545b9d66e.png)

See info on Parameters and Headers here:
https://learning.postman.com/docs/publishing-your-api/authoring-your-documentation/#parameters-and-headers

Beitragsleitfaden

Beitragsleitfaden öffnen

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.