Home → API Developers →

Computed vs. user entered fields

• Edit

Michael Latta

07 Feb, 2010 01:08 AM

I would like to see fields like open-tickets-count be marked as non-editable in the API so a client knows to present that to the user as read=only.

1. 1 Posted by Rick on 07 Feb, 2010 04:45 AM

   

   The ticket documentation lists which keys are available to be written:

   Create Ticket - POST /projects/#{project_id}/tickets.xml Creates a ticket. Missing attributes will remain their default, as shown in the new ticket request above. The shown fields are the only ones you can set:

   title body - follows the same formatting rules. state - Can be any one of these: new, open, resolved, hold, invalid. Optional, set to open by default for new tickets. assigned-user-id - optional milestone-id - optional tag - space or comma delimited list of tags

   There is no format for specifying in the actual API which fields are read only.

   • Edit

2. Rick closed this discussion on 07 Feb, 2010 04:45 AM.

3. Michael Latta re-opened this discussion on 07 Feb, 2010 05:20 AM

4. 2 Posted by Michael Latta on 07 Feb, 2010 05:20 AM

   

   I was requesting a new feature. It would be helpful to have that encoded in the API or accessible from the API so changes are automatically accounted for without hard-coding the fields.

   Michael

   • Edit

5. 3 Posted by Rick on 07 Feb, 2010 07:06 AM

   

   Thanks for the suggestion, but we're favoring JSON for all our new API
   formats (though the existing XML calls will continue to work). Most
   JSON APIs don't include any type of schema information, and our users
   aren't demanding it. We'll reconsider if we get a lot more requests
   for it.

   • Edit

6. 4 Posted by Michael Latta on 07 Feb, 2010 07:24 AM

   

   Hopefully project data will include som data or a separate call can
   provide it? Where are the Jason calls documented? The XML docs are
   getting out of date.

   Michael

   • Edit

7. 5 Posted by Rick on 07 Feb, 2010 07:55 AM

   

   Projects have their own API endpoint:
   http://lighthouseapp.com/api/projects. The JSON matches the XML key
   for key. Yes, the documentation does need a refresh though, as some
   new attributes have been updated here and there.

   • Edit

8. Nicole closed this discussion on 10 Feb, 2010 06:56 PM.