Skip to content
#

API

An API can be thought of as an instruction manual for communication between multiple software apparatuses. For example, an API may be used for database communication between web applications. By extracting the implementation and relinquishing data into objects, an API simplifies programming.

Here are 1,147 public repositories matching this topic...

Timunas
Timunas commented Sep 10, 2019

Custom error formatter must have now 5 arguments instead of the old 4. These changes were introduced here on #1652

When migrating from 0.19 to 1.1.0 I had issues on a custom error formatter because the original_exception argument was introduced but that change was not documented on the upgrading guide.

experimatt
experimatt commented Jan 30, 2020

This isn't a code-related issue, but a request to clarify email confirmation flows and endpoints in the documentation. I'd be happy to submit a pull request for this, but I need more information about how this is expected to work, before I'll be able to explain it. There's also related code that's been merged but not released yet (specifically: https://github.com/lynndylanhurley/devise_token_auth/

gonzalo-bulnes
gonzalo-bulnes commented Nov 26, 2017

When I would like to use Simple Token Authentication
But the gem doesn't quite fit my use case
I want be told about alternatives
So that I can understand the trade-offs that were made
And decide if I prefer creating a pull request or use another of the tools that are available

When I maintain a gem that provides token authentication using Devise
I want t

khiav223577
khiav223577 commented Apr 3, 2020

Error Messages

Coverage report generated for RSpec to /mnt/c/Users/b9990/Documents/GitHub/compassbioinfo/good_will_mina_api/coverage. 1125 / 1181 LOC (95.26
%) covered.
SimpleCov failed with exit 1
Traceback (most recent call last):
        45: from /home/khiav/.rvm/gems/ruby-2.5.5/gems/rspec-core-3.9.1/exe/rspec:4:in `<main>'
        44: from /home/khiav/.rvm/gems/ruby-2.5.5/gems/r
vladimirtcats
vladimirtcats commented Apr 21, 2020

I am trying to create documentation for this

    desc 'Returns your public timeline.' do
    summary 'summary'
    detail 'more details'
    named 'My named route'
    headers XAuthToken: {
              description: 'Validates your identity',
              required: true
            },
            XOptionalHeader: {
              description: 'Not really needed',
           
Kukunin
Kukunin commented Nov 8, 2017
      with_options documentation: {required: true, type: 'integer'} do
        expose :posts_count, as: :posts, documentation: {example: 7}
        expose :followers_count, as: :followers, documentation: {example: 105}
        expose :following_count, as: :following, documentation: {example: 52}
        expose :bookmarks_count, as: :bookmarks, documentation: {example: 22}
      end
ZeHiro
ZeHiro commented Feb 13, 2017

There should be documentation on how to interface with you software : what is the format out of the command line, if a JSON format is used, please describe it, this will ease the integration with other software, for example : Kresus (kresus.org), a libre self hosted account manager.
In addition, a command to list all the accounts (with IBAN + account label + balance) would also help into going th

Wikipedia
Wikipedia
You can’t perform that action at this time.