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.

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

[How to] add documentation for the /auth/xxx endpoints #54

Closed
idealley opened this issue Apr 7, 2017 · 0 comments
Closed

[How to] add documentation for the /auth/xxx endpoints #54

idealley opened this issue Apr 7, 2017 · 0 comments

Comments

@idealley
Copy link

idealley commented Apr 7, 2017

I had to figure out how to do this. Here is what I did:

I did not want the documentation for the token endpoints thus I removed them from the object:
services/authentication/index.js

  ...
  app.configure(authentication(config));
  //Removing endpoints from the documentation
  delete app.docs.paths['/auth/token'];
  delete app.docs.paths['/auth/token/{id}'];

Then I merged a definition that I keep in a separate file (here is an explanation or check the project I am working on)

app.docs.paths['/auth/token'].post = Object.assign({}, app.docs.paths['/auth/token'].post, def.post);

@jfmmm jfmmm mentioned this issue Aug 7, 2017
@idealley idealley changed the title How to add documentation for the /auth/xxx endpoints [How to] add documentation for the /auth/xxx endpoints Sep 1, 2017
@idealley idealley closed this as completed Sep 1, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant