Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add comments, examples to Swagger interface to the API #50

Open
erictheise opened this issue May 19, 2020 · 0 comments
Open

Add comments, examples to Swagger interface to the API #50

erictheise opened this issue May 19, 2020 · 0 comments
Labels
data Import, export or other bulk manipulation of data documentation Improvements or additions to documentation enhancement New feature or request
Projects
API
Milestone
Post-launch

Comments

@erictheise
Copy link
Member

The Directory API is used to power the Directory itself, to authenticate users of the Tool Library and potentially other PCC properties, and may conceivably power third-party development. Swagger was implemented to make this easier and would benefit from additional text and examples once the API is finalized.

There are some potentially valuable insights here and here.
@erictheise erictheise added documentation Improvements or additions to documentation enhancement New feature or request data Import, export or other bulk manipulation of data labels May 19, 2020
@erictheise erictheise added this to the Post-launch milestone May 19, 2020
@greatislander greatislander added this to To do in API May 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
data Import, export or other bulk manipulation of data documentation Improvements or additions to documentation enhancement New feature or request
Projects
API
  
To do
Milestone
Post-launch
Development

No branches or pull requests
1 participant
@erictheise