Plots2: Документация системы токенов для API записи

Эй, @jywarren, я могу поработать над этим?

Конечно, спасибо!

Извините за то, что не задокументировал эту функцию в тот момент, так как я торопился выполнить задачи на временной шкале. Спасибо, что согласились поработать над этим, @ namangupta01! Я хотел бы просмотреть его, как только вы закончите документировать.

Совершенно никаких проблем! Командная работа!

@ryzokuken Спасибо! :)

@jywarren @ryzokuken Итак, я работал над этой проблемой, мне было интересно, мне нужно только документировать комментарии через токен, то есть https://github.com/publiclab/plots2/pull/1513/files ?

@ namangupta01 правильно! Это PR, где я собственно написал код для комментирования через токен.

Привет всем! Могу я тоже помочь с этим? Как дела до сих пор? Я думал о том, чтобы начать писать документацию по токенам, чтобы лучше познакомиться с API.

@stefannibrasil Я думаю, что на данный момент это заброшено, так что вы можете свободно работать над этим. Сообщите нам, если у вас возникнут проблемы.

Спасибо, @ryzokuken. Я собираюсь начать работу над документированием функции токена на этой неделе. Я собираюсь увидеть несколько примеров и, конечно, сообщу вам все, что угодно. Спасибо за помощь!

@ sukhbir-singh ты тоже хочешь начать работать над этим? Мы сможем сравнить наши работы позже.

Ага! конечно: smile:
@stefannibrasil ты активен на gitter ??

Привет, @jywarren и @ryzokuken! После прочтения дополнительных документов, представленных здесь, у меня есть несколько вопросов:

• Файлы в папке app/api/src/ - это документы, которые Swagger использует для создания интерфейса , верно?

• Чтобы создать документацию для аутентификации токена, нужно ли мне создать новый файл в указанной выше папке, показывающий, как работает действие создания CommentController?

Это то, что я понимаю до сих пор. Буду признателен, если вы дадите немного больше информации по этому поводу. Спасибо!

@stefannibrasil для экономии времени и усилий, я не стал делать действие "комментирование токенов" частью существующей спецификации Swagger API и сделал автономную функцию в кодовой базе Rails (в CommentController вы справа) и проложил маршрут для этого.

Я не думаю , что Форс позволяет документировать внешние функции, но я могу ошибаться.
Итак, я считаю, что вам следует просто добавить некоторую документацию самостоятельно в doc/api.md в формате уценки, немного объяснив, как работает функция и как мы ожидаем, что пользователи будут добавлять свои собственные комментарии с помощью этой конечной точки.

Я надеюсь, что это проясняет, не стесняйтесь просить разъяснений по любому из этого.

В этом есть смысл, спасибо! Посмотрев больше на документы и как писать документы API, я добавил некоторые изменения в этот PR . Я не уверен, что вы просили именно такую ​​документацию.

Я добавил свои вопросы в описание, не могли бы вы взглянуть и посмотреть, можете ли вы мне помочь?

Я не смог найти много документации по токену, вы тоже можете сказать мне, где искать больше, это поможет! :)

@ sukhbir-singh извините, я не в gitter, но если вы хотите, вы тоже можете внести свой вклад в PR, это было бы здорово.

@stefannibrasil, вы можете посмотреть это видео для демонстрации, показывающей, как использовать почтальон для отправки запросов на API комментариев. : баллон:

Отлично, это закончено, или есть еще кое-что, что мы могли бы рассказать об этом? Не стесняйтесь закрыть его, если это будет сделано! Спасибо всем!!!

На самом деле, возможно, мы можем добавить пару дополнений - например, не могли бы мы улучшить POST https://publiclab.org/comment/create/token/id.:format до POST https://publiclab.org/comment/create/token/id.json чтобы показать, что вы можете указать такой формат. И, может быть, нам следует указать, где в источнике находится код API токена?

https://github.com/publiclab/plots2/blob/master/app/controllers/comment_controller.rb#L48 -L73

@jywarren +1, звучит идеально.

Привет всем! Это хорошие моменты, спасибо! PR уже слили, добавлю и тогда создам еще =)

Кроме того, спасибо @ sukhbir-singh, спасибо за помощь!

Без проблем...!! Рад помочь. Я очень активен в github, gitter и irc, вы можете пропинговать меня там дальше, если вам в любом случае понадобится помощь. : смайлик: