Git Product home page Git Product logo

auctions_api's Introduction

Auctions API Documentation

This is the documentation repository for the GSA Auctions API.

Thanks to CFPB team for creating this model and for furthering open source in government.

Using JavaScript and Bower

If you are going to work on the JavaScript for this site, you need to do the following:

  • Run npm install -g bower to install Bower.
  • Run npm install -g grunt-cli to install Grunt.
  • Run npm install in the directory to install other tools.
  • Run bower install to install dependencies.
  • Run bundle install to install additional dependencies.

After changing the JavaScript, run grunt to rebuild the minified JS.

auctions_api's People

Contributors

gbinal avatar gui avatar kishoregh avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

Forkers

ondrae gui gbinal

auctions_api's Issues

ensure Google Analytics setup

If it's not added yet, it should be.

If it is, it should be confirmed that it's the right snippet. I worry that it may be overlapping with the SAM API or even CFPB GA code.

@nvembar

Pagination

The default response size (>>10MB) is very large. Suggest adding the ability to get a subset of data (e.g. pagination) with a default response size of somewhere between 50 and 200 items in the response

Possible ways to implement:

  • page query parameter with an optional page_size that determines the number of responses per page
  • start and limit parameter that allow arbitrary subsets of the resources of a collection (e.g. slices). similar to pages except without starting at fixed indices

for collections, also nice to put a property indicating total items in the collection and /or max number of pages.

Syntax errors in JSON

Hi, I ran the raw JSON file through a JSON validator and found multiple syntax errors. I am going through them one by one and fixing, but was wondering if anyone else found the same issue + was unable to use the API for this reason? I'm a noob at making data requests from APIs, so go easy on me. :)

If/after I am done fixing the syntax errors, I can post the resulting JSON file here. The most common problem has been double quotes within double quotes. :(

styling off for /console

I'm not sure what's up but the styling is different in a couple ways on the API Calls page.

The main one is how the sidebar works. Here's how I see it in Chrome on most pages:

screen shot 2014-09-29 at 4 13 03 pm

But here's how it looks on /console:

screen shot 2014-09-29 at 4 12 47 pm

I'm guessing that a link in this file to a styling resource is broken but am not sure.

@adelevie, @nvembar - any thoughts?

add query parameters

Are there parameters by which a developer can query the underlying data? Those would increase the utility of the service significantly.

Once some are articulated, it'll be important to add them to the /basics page.

Implement the GSA API Standards

In November 2018, the GSA CTO and CIO directed all API programs at GSA to implement the GSA API Standards (details here). All current APIs at the agency have a deadline of Dec. 31, 2019 to do this.

This issue is to track the Auctions API's adoption of the Standards.

  • Add Your API To The GSA API Directory
  • Use The api.data.gov Service
  • Provide Support For Versioning
  • Provide Public Documentation
  • Provide A Feedback Mechanism That Is Clear and Monitored
  • Provide An OpenAPI Specification File

integrate the api key signup into your microsite

@GUI - can you share instructions or file a pull request for how we could integrate the api key signup into a page on gsa.github.io/auctions_api?

I'd then recommend adding a sidebar nav item for the api key signup page. That way developers don't leave your microsite when they get a key

Console does not show up

I wanted to play around with the Console, but it does not seem to be showing up--I see a blank spot where the console should be. I'm using the latest version of Chrome, and also checked Safari.

Screenshot:
screenshot 2014-10-01 06 04 19

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.