{"swagger":"2.0","info":{"title":"apibuilder api","description":"Host API documentation for applications providing REST APIs, facilitating the design of good resource first APIs.","contact":{"name":"Michael Bryzek","url":"http://twitter.com/mbryzek","email":"mbryzek@alum.mit.edu"},"license":{"name":"MIT","url":"http://opensource.org/licenses/MIT"},"version":"0.0.1-dev"},"host":"api.apibuilder.io","basePath":"/","schemes":["https"],"consumes":["application/json"],"produces":["application/json"],"paths":{"/{orgKey}/metadata/{applicationKey}/versions":{"get":{"description":"Returns the versions assocoated with the specified application. The latest version is the first result returned.","parameters":[{"name":"orgKey","in":"path","required":true,"type":"string"},{"name":"applicationKey","in":"path","required":true,"type":"string"},{"name":"limit","in":"query","description":"The number of records to return","required":true,"default":"25","maximum":100,"type":"integer","format":"int64"},{"name":"offset","in":"query","description":"Used to paginate. First page of results is 0.","required":true,"default":"0","minimum":0,"type":"integer","format":"int64"}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/application_metadata_version"}}},"401":{"description":"401 response"},"404":{"description":"404 response"}}}},"/{orgKey}/metadata/{applicationKey}/versions/latest.txt":{"get":{"description":"Returns the latest version number as a string","parameters":[{"name":"orgKey","in":"path","required":true,"type":"string"},{"name":"applicationKey","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/string"}},"401":{"description":"401 response"},"404":{"description":"404 response"}}}},"/{orgKey}":{"get":{"description":"Search all applications. Results are always paginated.","parameters":[{"name":"orgKey","in":"path","description":"The organization key for which to search applications","required":true,"type":"string"},{"name":"name","in":"query","description":"The name of an application. Case in-sensitive. Exact match","required":false,"type":"string"},{"name":"guid","in":"query","description":"The guid of an application. Exact match","required":false,"type":"string","format":"uuid"},{"name":"key","in":"query","description":"The key of an application. Case in-sensitive. Exact match","required":false,"type":"string"},{"name":"has_version","in":"query","description":"If true, we return applications that have at least one version. If false, we return applications that have no versions in the system","required":false,"type":"boolean"},{"name":"limit","in":"query","description":"The number of records to return","required":true,"default":"25","maximum":100,"type":"integer","format":"int64"},{"name":"offset","in":"query","description":"Used to paginate. First page of results is 0.","required":true,"default":"0","minimum":0,"type":"integer","format":"int64"},{"name":"sort_by","in":"query","required":false},{"name":"order","in":"query","required":false}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/application"}}}}},"post":{"description":"Create an application.","parameters":[{"name":"orgKey","in":"path","required":true,"type":"string"},{"name":"application_form","in":"body","schema":{"$ref":"#/definitions/application_form"}}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/application"}},"409":{"description":"409 response","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}}}},"/{orgKey}/{applicationKey}":{"get":{"description":"Search all versions of this application. Results are always paginated.","parameters":[{"name":"orgKey","in":"path","description":"The organization key for which to search versions","required":true,"type":"string"},{"name":"applicationKey","in":"path","description":"The application key for which to search versions","required":true,"type":"string"},{"name":"limit","in":"query","description":"The number of records to return","required":true,"default":"25","maximum":100,"type":"integer","format":"int64"},{"name":"offset","in":"query","description":"Used to paginate. First page of results is 0.","required":true,"default":"0","minimum":0,"type":"integer","format":"int64"}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/version"}}}}}},"/{orgKey}/{applicationKey}/move":{"post":{"description":"Moves application to a new organization.","parameters":[{"name":"orgKey","in":"path","required":true,"type":"string"},{"name":"applicationKey","in":"path","required":true,"type":"string"},{"name":"move_form","in":"body","schema":{"$ref":"#/definitions/move_form"}}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/application"}},"409":{"description":"409 response","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}}}},"/attributes":{"get":{"description":"Search all attributes. Results are always paginated.","parameters":[{"name":"guid","in":"query","description":"Find the watch with this guid.","required":false,"type":"string","format":"uuid"},{"name":"name","in":"query","description":"Find attributes with this name. Case in-sensitive. Exact match","required":false,"type":"string"},{"name":"limit","in":"query","description":"The number of records to return","required":true,"default":"25","maximum":100,"minimum":1,"type":"integer","format":"int64"},{"name":"offset","in":"query","description":"Used to paginate. First page of results is 0.","required":true,"default":"0","minimum":0,"type":"integer","format":"int64"}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/attribute"}}}}},"post":{"description":"Create a new attribute.","parameters":[{"name":"attribute_form","in":"body","schema":{"$ref":"#/definitions/attribute_form"}}],"responses":{"201":{"description":"201 response","schema":{"$ref":"#/definitions/attribute"}},"401":{"description":"401 response"},"409":{"description":"409 response","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}}}},"/attributes/{name}":{"get":{"description":"Returns the attribute with this name.","parameters":[{"name":"name","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/attribute"}},"404":{"description":"404 response"}}},"delete":{"description":"Deletes the attribute with this name. Only the user who created an attribute can delete it.","parameters":[{"name":"name","in":"path","required":true,"type":"string"}],"responses":{"204":{"description":"204 response"},"401":{"description":"401 response"},"404":{"description":"404 response"}}}},"/authentications/session/{id}":{"get":{"parameters":[{"name":"id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/authentication"}},"404":{"description":"404 response"}}}},"/changes":{"get":{"parameters":[{"name":"org_key","in":"query","description":"Filter changes to those made for the organization with this key.","required":false,"type":"string"},{"name":"application_key","in":"query","description":"Filter changes to those made for the application with this key.","required":false,"type":"string"},{"name":"from","in":"query","description":"Filter changes to those made from this version.","required":false,"type":"string"},{"name":"to","in":"query","description":"Filter changes to those made to this version.","required":false,"type":"string"},{"name":"type","in":"query","description":"The type of diff to return.","required":false,"type":"string"},{"name":"limit","in":"query","description":"The number of records to return","required":true,"default":"25","maximum":100,"minimum":1,"type":"integer","format":"int64"},{"name":"offset","in":"query","description":"Used to paginate. First page of results is 0.","required":true,"default":"0","minimum":0,"type":"integer","format":"int64"}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/change"}}}}}},"/{orgKey}/{applicationKey}/{version}/form":{"post":{"description":"Create an invocation form. This is useful primarily for debugging when you want to see exactly what content is being forwarded to the generator","parameters":[{"name":"orgKey","in":"path","required":true,"type":"string"},{"name":"applicationKey","in":"path","required":true,"type":"string"},{"name":"version","in":"path","required":true,"type":"string"},{"name":"code_form","in":"body","schema":{"$ref":"#/definitions/code_form"}}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/io.apibuilder.generator.v0.models.invocation_form"}},"409":{"description":"409 response","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}}}},"/{orgKey}/{applicationKey}/{version}/{generatorKey}":{"get":{"description":"Generate code for a specific version of an application.","parameters":[{"name":"orgKey","in":"path","description":"The organization key for which to generate code","required":true,"type":"string"},{"name":"applicationKey","in":"path","description":"The application key for which to generate code","required":true,"type":"string"},{"name":"version","in":"path","description":"The version of this application. Can be 'latest'","required":true,"type":"string"},{"name":"generatorKey","in":"path","description":"The key of the generator to invoke","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/code"}},"409":{"description":"If the target, version, and/or generator are invalid.","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}}},"post":{"description":"Generate code for a specific version of an application.","parameters":[{"name":"orgKey","in":"path","description":"The organization key for which to generate code","required":true,"type":"string"},{"name":"applicationKey","in":"path","description":"The application key for which to generate code","required":true,"type":"string"},{"name":"version","in":"path","description":"The version of this application. Can be 'latest'","required":true,"type":"string"},{"name":"generatorKey","in":"path","description":"The key of the generator to invoke","required":true,"type":"string"},{"name":"code_form","in":"body","schema":{"$ref":"#/definitions/code_form"}}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/code"}},"409":{"description":"If the target, version, and/or generator are invalid.","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}}}},"/domains/{orgKey}":{"post":{"description":"Add a domain to this organization","parameters":[{"name":"orgKey","in":"path","required":true,"type":"string"},{"name":"domain","in":"body","schema":{"$ref":"#/definitions/domain"}}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/domain"}},"409":{"description":"409 response","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}}}},"/domains/{orgKey}/{name}":{"delete":{"description":"Remove this domain from this organization","parameters":[{"name":"orgKey","in":"path","required":true,"type":"string"},{"name":"name","in":"path","required":true,"type":"string"}],"responses":{"204":{"description":"204 response"},"401":{"description":"401 response"},"404":{"description":"404 response"}}}},"/email_verification_confirmations":{"post":{"description":"Validate an email address using a token.","parameters":[{"name":"email_verification_confirmation_form","in":"body","schema":{"$ref":"#/definitions/email_verification_confirmation_form"}}],"responses":{"204":{"description":"204 response"},"409":{"description":"409 response","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}}}},"/generator_services":{"get":{"description":"List all generator services","parameters":[{"name":"guid","in":"query","required":false,"type":"string","format":"uuid"},{"name":"uri","in":"query","required":false,"type":"string"},{"name":"generator_key","in":"query","required":false,"type":"string"},{"name":"limit","in":"query","description":"The number of records to return","required":true,"default":"100","maximum":100,"minimum":1,"type":"integer","format":"int64"},{"name":"offset","in":"query","description":"Used to paginate. First page of results is 0.","required":true,"default":"0","minimum":0,"type":"integer","format":"int64"}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/generator_service"}}}}},"post":{"parameters":[{"name":"generator_service_form","in":"body","schema":{"$ref":"#/definitions/generator_service_form"}}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/generator_service"}},"409":{"description":"409 response","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}}}},"/generator_services/{guid}":{"get":{"parameters":[{"name":"guid","in":"path","required":true,"type":"string","format":"uuid"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/generator_service"}},"404":{"description":"404 response"}}},"delete":{"description":"Deletes a generator service.","parameters":[{"name":"guid","in":"path","required":true,"type":"string","format":"uuid"}],"responses":{"204":{"description":"204 response"},"401":{"description":"401 response"},"404":{"description":"404 response"}}}},"/generators":{"get":{"description":"List all available generators","parameters":[{"name":"guid","in":"query","description":"Filter to generator with this guid","required":false,"type":"string","format":"uuid"},{"name":"service_guid","in":"query","description":"Filter to generator from this service","required":false,"type":"string","format":"uuid"},{"name":"service_uri","in":"query","description":"Filter to generator from this service URI","required":false,"type":"string"},{"name":"attribute_name","in":"query","description":"Filter to generators that use this attribute","required":false,"type":"string"},{"name":"key","in":"query","description":"Filter to generator with this key","required":false,"type":"string"},{"name":"limit","in":"query","description":"The number of records to return","required":true,"default":"100","maximum":100,"minimum":1,"type":"integer","format":"int64"},{"name":"offset","in":"query","description":"Used to paginate. First page of results is 0.","required":true,"default":"0","minimum":0,"type":"integer","format":"int64"}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/generator_with_service"}}}}}},"/generators/{key}":{"get":{"parameters":[{"name":"key","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/generator_with_service"}},"404":{"description":"404 response"}}}},"/_internal_/healthcheck":{"get":{"parameters":[],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/io.apibuilder.generator.v0.models.healthcheck"}}}}},"/_internal_/migrate":{"get":{"parameters":[],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/map[string]"}}}}},"/items":{"get":{"parameters":[{"name":"q","in":"query","description":"The search query. At the moment, we do case insensitive exact match search.","required":false,"type":"string"},{"name":"limit","in":"query","description":"The number of records to return","required":true,"default":"25","maximum":100,"minimum":1,"type":"integer","format":"int64"},{"name":"offset","in":"query","description":"Used to paginate. First page of results is 0.","required":true,"default":"0","minimum":0,"type":"integer","format":"int64"}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/item"}}}}}},"/items/{guid}":{"get":{"parameters":[{"name":"guid","in":"path","required":true,"type":"string","format":"uuid"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/item"}},"404":{"description":"404 response"}}}},"/memberships":{"get":{"description":"Search all memberships. Results are always paginated.","parameters":[{"name":"org_guid","in":"query","required":false,"type":"string","format":"uuid"},{"name":"org_key","in":"query","required":false,"type":"string"},{"name":"user_guid","in":"query","required":false,"type":"string","format":"uuid"},{"name":"role","in":"query","required":false,"type":"string"},{"name":"limit","in":"query","description":"The number of records to return","required":true,"default":"25","maximum":100,"minimum":1,"type":"integer","format":"int64"},{"name":"offset","in":"query","description":"Used to paginate. First page of results is 0.","required":true,"default":"0","minimum":0,"type":"integer","format":"int64"}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/membership"}}}}}},"/memberships/{guid}":{"get":{"parameters":[{"name":"guid","in":"path","required":true,"type":"string","format":"uuid"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/membership"}},"404":{"description":"404 response"}}},"delete":{"parameters":[{"name":"guid","in":"path","required":true,"type":"string","format":"uuid"}],"responses":{"204":{"description":"204 response"},"401":{"description":"401 response"},"404":{"description":"404 response"}}}},"/membership_requests":{"get":{"description":"Search all membership requests. Results are always paginated.","parameters":[{"name":"org_guid","in":"query","required":false,"type":"string","format":"uuid"},{"name":"org_key","in":"query","required":false,"type":"string"},{"name":"user_guid","in":"query","required":false,"type":"string","format":"uuid"},{"name":"role","in":"query","required":false,"type":"string"},{"name":"limit","in":"query","description":"The number of records to return","required":true,"default":"25","maximum":100,"minimum":1,"type":"integer","format":"int64"},{"name":"offset","in":"query","description":"Used to paginate. First page of results is 0.","required":true,"default":"0","minimum":0,"type":"integer","format":"int64"}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/membership_request"}}}}},"post":{"description":"Create a membership request","parameters":[{"name":"org_guid","in":"form","required":true,"type":"string","format":"uuid"},{"name":"user_guid","in":"form","required":true,"type":"string","format":"uuid"},{"name":"role","in":"form","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/membership_request"}},"409":{"description":"409 response","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}}}},"/membership_requests/{guid}/accept":{"post":{"description":"Accepts this membership request. User will become a member of the specified organization.","parameters":[{"name":"guid","in":"path","required":true,"type":"string","format":"uuid"}],"responses":{"204":{"description":"204 response"},"409":{"description":"409 response","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}}}},"/membership_requests/{guid}/decline":{"post":{"description":"Declines this membership request. User will NOT become a member of the specified organization.","parameters":[{"name":"guid","in":"path","required":true,"type":"string","format":"uuid"}],"responses":{"204":{"description":"204 response"},"409":{"description":"409 response","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}}}},"/organizations":{"get":{"description":"Search all organizations. Results are always paginated.","parameters":[{"name":"guid","in":"query","description":"Finds the organization with this guid, if any","required":false,"type":"string","format":"uuid"},{"name":"user_guid","in":"query","description":"If specified, restricts to organizations that this user is specifically a member of (e.g. will exclude public organizations with which the user does not have a direct membership).","required":false,"type":"string","format":"uuid"},{"name":"key","in":"query","description":"Find organizations with this key. Case in-sensitive. Exact match","required":false,"type":"string"},{"name":"name","in":"query","description":"Find organizations with this name. Case in-sensitive. Exact match","required":false,"type":"string"},{"name":"namespace","in":"query","description":"Find organizations with this namespace. Case in-sensitive. Exact match","required":false,"type":"string"},{"name":"limit","in":"query","description":"The number of records to return","required":true,"default":"25","maximum":100,"minimum":1,"type":"integer","format":"int64"},{"name":"offset","in":"query","description":"Used to paginate. First page of results is 0.","required":true,"default":"0","minimum":0,"type":"integer","format":"int64"}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/organization"}}}}},"post":{"description":"Create a new organization.","parameters":[{"name":"organization_form","in":"body","schema":{"$ref":"#/definitions/organization_form"}}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/organization"}},"409":{"description":"409 response","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}}}},"/organizations/{key}":{"get":{"description":"Returns the organization with this key.","parameters":[{"name":"key","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/organization"}},"404":{"description":"404 response"}}},"put":{"description":"Update an organization.","parameters":[{"name":"key","in":"path","required":true,"type":"string"},{"name":"organization_form","in":"body","schema":{"$ref":"#/definitions/organization_form"}}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/organization"}},"409":{"description":"409 response","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}}},"delete":{"description":"Deletes an organization and all of its associated applications.","parameters":[{"name":"key","in":"path","required":true,"type":"string"}],"responses":{"204":{"description":"204 response"},"401":{"description":"401 response"},"404":{"description":"404 response"}}}},"/organizations/{key}/attributes":{"get":{"description":"Returns all attribute values for this organization. Results are always paginated.","parameters":[{"name":"key","in":"path","required":true,"type":"string"},{"name":"name","in":"query","description":"Find the values for the attribute with this name.","required":false,"type":"string"},{"name":"limit","in":"query","description":"The number of records to return","required":true,"default":"25","maximum":100,"minimum":1,"type":"integer","format":"int64"},{"name":"offset","in":"query","description":"Used to paginate. First page of results is 0.","required":true,"default":"0","minimum":0,"type":"integer","format":"int64"}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/attribute_value"}}}}}},"/organizations/{key}/attributes/{name}":{"get":{"description":"Returns the attribute value with this name.","parameters":[{"name":"key","in":"path","required":true,"type":"string"},{"name":"name","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/attribute_value"}},"404":{"description":"404 response"}}},"put":{"description":"Create or update a new attribute value.","parameters":[{"name":"key","in":"path","required":true,"type":"string"},{"name":"name","in":"path","required":true,"type":"string"},{"name":"attribute_value_form","in":"body","schema":{"$ref":"#/definitions/attribute_value_form"}}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/attribute_value"}},"201":{"description":"201 response","schema":{"$ref":"#/definitions/attribute_value"}},"404":{"description":"404 response"},"409":{"description":"409 response","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}}},"delete":{"description":"Deletes the attribute value with the specified name. Only the user who created an attribute value can delete it.","parameters":[{"name":"key","in":"path","required":true,"type":"string"},{"name":"name","in":"path","required":true,"type":"string"}],"responses":{"204":{"description":"204 response"},"401":{"description":"401 response"},"404":{"description":"404 response"}}}},"/password_resets":{"post":{"description":"Change the password for this token. If the token is invalid, has been used, or otherwise no longer can be applied, errors will be returned as 409s. A 204 represents that the user has successfully changed their password.","parameters":[{"name":"password_reset","in":"body","schema":{"$ref":"#/definitions/password_reset"}}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/authentication"}},"409":{"description":"409 response","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}}}},"/password_reset_requests":{"post":{"description":"Create a new password reset. This will send the user an email with a link to reset their password.","parameters":[{"name":"password_reset_request","in":"body","schema":{"$ref":"#/definitions/password_reset_request"}}],"responses":{"204":{"description":"204 response"},"409":{"description":"409 response","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}}}},"/subscriptions":{"get":{"description":"Search subscriptions. Always paginated.","parameters":[{"name":"guid","in":"query","description":"Find the subscription with this guid.","required":false,"type":"string","format":"uuid"},{"name":"organization_key","in":"query","description":"Find subscriptions for this organization.","required":false,"type":"string"},{"name":"user_guid","in":"query","description":"Find subscriptions for this user.","required":false,"type":"string","format":"uuid"},{"name":"publication","in":"query","description":"Find subscriptions for this publication.","required":false},{"name":"limit","in":"query","description":"The number of records to return","required":true,"default":"25","maximum":100,"minimum":1,"type":"integer","format":"int64"},{"name":"offset","in":"query","description":"Used to paginate. First page of results is 0.","required":true,"default":"0","minimum":0,"type":"integer","format":"int64"}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/subscription"}}}}},"post":{"description":"Create a new subscription.","parameters":[{"name":"subscription_form","in":"body","schema":{"$ref":"#/definitions/subscription_form"}}],"responses":{"201":{"description":"201 response","schema":{"$ref":"#/definitions/subscription"}},"409":{"description":"409 response","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}}}},"/subscriptions/{guid}":{"get":{"description":"Returns information about a specific subscription.","parameters":[{"name":"guid","in":"path","required":true,"type":"string","format":"uuid"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/subscription"}},"404":{"description":"404 response"}}},"delete":{"parameters":[{"name":"guid","in":"path","required":true,"type":"string","format":"uuid"}],"responses":{"204":{"description":"204 response"},"401":{"description":"401 response"},"404":{"description":"404 response"}}}},"/tokens/users/{user_guid}":{"get":{"parameters":[{"name":"user_guid","in":"path","required":true,"type":"string","format":"uuid"},{"name":"guid","in":"query","required":false,"type":"string","format":"uuid"},{"name":"limit","in":"query","description":"The number of records to return","required":true,"default":"25","maximum":100,"minimum":1,"type":"integer","format":"int64"},{"name":"offset","in":"query","description":"Used to paginate. First page of results is 0.","required":true,"default":"0","minimum":0,"type":"integer","format":"int64"}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/token"}}}}}},"/tokens/{guid}/cleartext":{"get":{"description":"Used to fetch the clear text token.","parameters":[{"name":"guid","in":"path","required":true,"type":"string","format":"uuid"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/cleartext_token"}},"404":{"description":"404 response"}}}},"/tokens":{"post":{"description":"Create a new API token for this user","parameters":[{"name":"token_form","in":"body","schema":{"$ref":"#/definitions/token_form"}}],"responses":{"201":{"description":"201 response","schema":{"$ref":"#/definitions/token"}},"409":{"description":"409 response","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}}}},"/tokens/{guid}":{"delete":{"parameters":[{"name":"guid","in":"path","required":true,"type":"string","format":"uuid"}],"responses":{"204":{"description":"204 response"},"401":{"description":"401 response"},"404":{"description":"404 response"}}}},"/users":{"get":{"description":"Search for a specific user. You must specify at least 1 parameter - either a guid, email or token - and will receive back either 0 or 1 users.","parameters":[{"name":"guid","in":"query","description":"Find user with this guid. Exact match","required":false,"type":"string","format":"uuid"},{"name":"email","in":"query","description":"Find user with this email address. Case in-sensitive. Exact match","required":false,"type":"string"},{"name":"nickname","in":"query","description":"Find user with the specified nickname. For users that register via GitHub, this will be their GitHub username. Case in-sensitive. Exact match","required":false,"type":"string"},{"name":"token","in":"query","description":"Find the user with this API token. Exact match","required":false,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/user"}}}}},"post":{"description":"Create a new user.","parameters":[{"name":"user_form","in":"body","schema":{"$ref":"#/definitions/user_form"}}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/user"}},"409":{"description":"409 response","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}}}},"/users/{guid}":{"get":{"description":"Returns information about the user with this guid.","parameters":[{"name":"guid","in":"path","required":true,"type":"string","format":"uuid"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/user"}},"404":{"description":"404 response"}}},"put":{"description":"Updates information about the user with the specified guid.","parameters":[{"name":"guid","in":"path","required":true,"type":"string","format":"uuid"},{"name":"user_update_form","in":"body","schema":{"$ref":"#/definitions/user_update_form"}}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/user"}},"409":{"description":"409 response","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}}}},"/users/authenticate":{"post":{"description":"Used to authenticate a user with an email address and password. Successful authentication returns an instance of the user model. Failed authorizations of any kind are returned as a generic error with code user_authorization_failed.","parameters":[{"name":"email","in":"form","required":true,"type":"string"},{"name":"password","in":"form","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/authentication"}},"409":{"description":"409 response","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}}}},"/users/authenticate_github":{"post":{"description":"Used to authenticate a user using a github access token. This is equivalent to running the following command to get the user info: curl -H 'Authorization: Bearer code' https://api.github.com/user","parameters":[{"name":"token","in":"form","description":"The GitHub assigned oauth token","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/authentication"}},"409":{"description":"409 response","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}}}},"/validations":{"post":{"parameters":[{"name":"string","in":"body","schema":{"$ref":"#/definitions/string"}}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/validation"}}}}},"/{orgKey}/{applicationKey}/{version}":{"get":{"description":"Retrieve a specific version of an application.","parameters":[{"name":"orgKey","in":"path","required":true,"type":"string"},{"name":"applicationKey","in":"path","required":true,"type":"string"},{"name":"version","in":"path","description":"The version of tthis application to download, or the keyword latest to get the latest version","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/version"}},"404":{"description":"404 response"}}},"put":{"description":"Upsert a version of an application","parameters":[{"name":"orgKey","in":"path","required":true,"type":"string"},{"name":"applicationKey","in":"path","required":true,"type":"string"},{"name":"version","in":"path","required":true,"type":"string"},{"name":"version_form","in":"body","schema":{"$ref":"#/definitions/version_form"}}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/version"}},"409":{"description":"409 response","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}}},"delete":{"description":"Deletes a specific version.","parameters":[{"name":"orgKey","in":"path","required":true,"type":"string"},{"name":"applicationKey","in":"path","required":true,"type":"string"},{"name":"version","in":"path","required":true,"type":"string"}],"responses":{"204":{"description":"204 response"},"401":{"description":"401 response"},"404":{"description":"404 response"}}}},"/{orgKey}/{version}":{"post":{"description":"Create a new version for an application","parameters":[{"name":"orgKey","in":"path","required":true,"type":"string"},{"name":"version","in":"path","required":true,"type":"string"},{"name":"version_form","in":"body","schema":{"$ref":"#/definitions/version_form"}}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/version"}},"409":{"description":"409 response","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}}}},"/{orgKey}/{applicationKey}/{version}/example/{type_name}":{"get":{"description":"Generates an example JSON document of the type with the specified name.","parameters":[{"name":"orgKey","in":"path","required":true,"type":"string"},{"name":"applicationKey","in":"path","required":true,"type":"string"},{"name":"version","in":"path","description":"The version of this application to download, or the keyword latest to get the latest version","required":true,"type":"string"},{"name":"type_name","in":"path","description":"The name of the type (e.g. model name) for which you would like to generate a sample json document","required":true,"type":"string"},{"name":"sub_type_name","in":"query","description":"The name of the sub-type for which you would like to generate a sample json document, e.g. a specific type of a union","required":false,"type":"string"},{"name":"optional_fields","in":"query","description":"If true, we generate sample data for all optional fields. Otherwise the generated sample will contain only required fields, where applicable","required":false,"type":"boolean"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/object"}},"404":{"description":"404 response"}}}},"/watches":{"get":{"description":"Search attributes. Always paginated.","parameters":[{"name":"guid","in":"query","description":"Find the watch with this guid.","required":false,"type":"string","format":"uuid"},{"name":"user_guid","in":"query","description":"Find attributes for this user.","required":false,"type":"string","format":"uuid"},{"name":"organization_key","in":"query","description":"Find attributes for this organization.","required":false,"type":"string"},{"name":"application_key","in":"query","description":"Find attributes for this application.","required":false,"type":"string"},{"name":"limit","in":"query","description":"The number of records to return","required":true,"default":"25","maximum":100,"minimum":1,"type":"integer","format":"int64"},{"name":"offset","in":"query","description":"Used to paginate. First page of results is 0.","required":true,"default":"0","minimum":0,"type":"integer","format":"int64"}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/watch"}}}}},"post":{"description":"Create a new watch.","parameters":[{"name":"watch_form","in":"body","schema":{"$ref":"#/definitions/watch_form"}}],"responses":{"201":{"description":"201 response","schema":{"$ref":"#/definitions/watch"}},"409":{"description":"409 response","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}}}},"/watches/{guid}":{"get":{"description":"Returns information about a specific watch.","parameters":[{"name":"guid","in":"path","required":true,"type":"string","format":"uuid"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/watch"}},"404":{"description":"404 response"}}},"delete":{"parameters":[{"name":"guid","in":"path","required":true,"type":"string","format":"uuid"}],"responses":{"204":{"description":"204 response"},"401":{"description":"401 response"},"404":{"description":"404 response"}}}},"/watches/check":{"get":{"description":"Quick check if a user is watching a specific application.","parameters":[{"name":"user_guid","in":"query","description":"The user for which we are checking. API returns false if the user guid is not provided","required":false,"type":"string","format":"uuid"},{"name":"organization_key","in":"query","required":true,"type":"string"},{"name":"application_key","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/boolean"}}}}}},"definitions":{"application":{"type":"object","description":"An application has a name and multiple versions of its API.","title":"application","required":["guid","organization","name","key","visibility","last_updated_at","audit"],"properties":{"guid":{"description":"Internal unique identifier for this application.","type":"string","format":"uuid"},"organization":{"$ref":"#/definitions/io.apibuilder.common.v0.models.reference"},"name":{"description":"The unique name for this application.","type":"string"},"key":{"description":"Used as a unique key in the URL path. Key is automatically derived from the application name.","type":"string"},"visibility":{"type":"string","enum":["user","organization","public"]},"description":{"type":"string"},"last_updated_at":{"description":"The updated_at of this application or created_at of it's latest version","type":"string","format":"date-time"},"audit":{"$ref":"#/definitions/io.apibuilder.common.v0.models.audit"}}},"application_form":{"type":"object","title":"application_form","required":["name","visibility"],"properties":{"name":{"type":"string"},"key":{"description":"Defaults to a key generated from the application name","type":"string"},"description":{"type":"string"},"visibility":{"type":"string","enum":["user","organization","public"]}}},"application_metadata":{"type":"object","title":"application_metadata","required":["guid","key"],"properties":{"guid":{"description":"Internal unique identifier for this application.","type":"string","format":"uuid"},"key":{"description":"Used as a unique key in the URL path. Key is automatically derived from the application name.","type":"string"}}},"application_metadata_version":{"type":"object","description":"Describes the versions associated with a given application","title":"application_metadata_version","required":["version"],"properties":{"version":{"example":"0.2.5","type":"string"}}},"application_summary":{"type":"object","description":"Summary of an application sufficient for display and links","title":"application_summary","required":["guid","organization","key"],"properties":{"guid":{"type":"string","format":"uuid"},"organization":{"$ref":"#/definitions/io.apibuilder.common.v0.models.reference"},"key":{"type":"string"}}},"attribute":{"type":"object","description":"Attributes are globally unique key which allow users to specify additional content to pass in to the code generators.","title":"attribute","required":["guid","name","audit"],"properties":{"guid":{"description":"Internal unique identifier for this attribute.","type":"string","format":"uuid"},"name":{"description":"The name of the attribute. Globally unique and an 'identifier' (lower case, url safe, etc.)","type":"string"},"description":{"description":"Optional description - a good description here will indicate which code generators it applies to and what effect it will have on those code generators.","type":"string"},"audit":{"$ref":"#/definitions/io.apibuilder.common.v0.models.audit"}}},"attribute_form":{"type":"object","title":"attribute_form","required":["name"],"properties":{"name":{"type":"string"},"description":{"type":"string"}}},"attribute_summary":{"type":"object","title":"attribute_summary","required":["guid","name"],"properties":{"guid":{"description":"Internal unique identifier for this attribute.","type":"string","format":"uuid"},"name":{"description":"The name of the attribute. Globally unique and an 'identifier' (lower case, url safe, etc.)","type":"string"}}},"attribute_value":{"type":"object","description":"Attribute values can be set at different levels. Initially we support setting organization wide attributes, but in the future plan to support setting attribute values with each version of the application.","title":"attribute_value","required":["guid","attribute","value","audit"],"properties":{"guid":{"description":"Internal unique identifier for this attribute value.","type":"string","format":"uuid"},"attribute":{"$ref":"#/definitions/attribute_summary"},"value":{"type":"string"},"audit":{"$ref":"#/definitions/io.apibuilder.common.v0.models.audit"}}},"attribute_value_form":{"type":"object","title":"attribute_value_form","required":["value"],"properties":{"value":{"type":"string"}}},"authentication":{"type":"object","description":"Represents the result of a successful authorization","title":"authentication","required":["user","session"],"properties":{"user":{"$ref":"#/definitions/user"},"session":{"$ref":"#/definitions/session"}}},"change":{"type":"object","description":"Represents a single change from one version of a service to another","title":"change","required":["guid","organization","application","from_version","to_version","diff","changed_at","changed_by","audit"],"properties":{"guid":{"type":"string","format":"uuid"},"organization":{"$ref":"#/definitions/io.apibuilder.common.v0.models.reference"},"application":{"$ref":"#/definitions/io.apibuilder.common.v0.models.reference"},"from_version":{"$ref":"#/definitions/change_version"},"to_version":{"$ref":"#/definitions/change_version"},"diff":{"$ref":"#/definitions/diff"},"changed_at":{"description":"Records the timestamp of when the actual change occurred (vs. when we created the changed record)","type":"string","format":"date-time"},"changed_by":{"$ref":"#/definitions/user_summary"},"audit":{"$ref":"#/definitions/io.apibuilder.common.v0.models.audit"}}},"change_version":{"type":"object","description":"Represents a simpler model of a version specifically for the use case of displaying changes","title":"change_version","required":["guid","version"],"properties":{"guid":{"type":"string","format":"uuid"},"version":{"type":"string"}}},"cleartext_token":{"type":"object","description":"Separate resource used only for the few actions that require the full token.","title":"cleartext_token","required":["token"],"properties":{"token":{"description":"The actual token. Guaranteed to be globally unique.","type":"string"}}},"code":{"type":"object","description":"Generated source code.","title":"code","required":["generator","source","files"],"properties":{"generator":{"$ref":"#/definitions/generator_with_service"},"source":{"description":"The actual source code.","type":"string"},"files":{"type":"array","items":{"$ref":"#/definitions/io.apibuilder.generator.v0.models.file"}}}},"code_form":{"type":"object","title":"code_form","required":["attributes"],"properties":{"attributes":{"type":"array","items":{"$ref":"#/definitions/io.apibuilder.generator.v0.models.attribute"}}}},"diff_breaking":{"type":"object","description":"Represents a single breaking diff of an application version. A breaking diff indicates that it is possible for an existing client to now experience an error or invalid data due to the diff.","title":"diff_breaking","required":["description"],"properties":{"description":{"example":"model removed: user","type":"string"}}},"diff_non_breaking":{"type":"object","description":"Represents a single NON breaking diff of an application version.","title":"diff_non_breaking","required":["description"],"properties":{"description":{"example":"name diffd from foo to bar","type":"string"}}},"domain":{"type":"object","description":"Represents a single domain name (e.g. www.apibuilder.io). When a new user registers and confirms their email, we automatically associate that user with a member of the organization associated with their domain. For example, if you confirm your account with an email address of example@somedomain.com, we will automatically create a membership request on your behalf to join the organization with domain somedomain.com.","title":"domain","required":["name"],"properties":{"name":{"description":"The domain name","example":"www.apibuilder.io","type":"string"}}},"email_verification_confirmation_form":{"type":"object","description":"Data used to confirm an email address. The token is an internal unique identifier used to lookup the specific email address and user account for which we sent an email verification email.","title":"email_verification_confirmation_form","required":["token"],"properties":{"token":{"type":"string"}}},"error":{"type":"object","title":"error","required":["code","message"],"properties":{"code":{"description":"Machine readable code for this specific error message","type":"string"},"message":{"description":"Description of the error","type":"string"}}},"generator_form":{"type":"object","title":"generator_form","required":["service_guid","generator"],"properties":{"service_guid":{"type":"string","format":"uuid"},"generator":{"$ref":"#/definitions/io.apibuilder.generator.v0.models.generator"}}},"generator_service":{"type":"object","description":"Defines a service that provides one or more code generators","title":"generator_service","required":["guid","uri","audit"],"properties":{"guid":{"type":"string","format":"uuid"},"uri":{"type":"string"},"audit":{"$ref":"#/definitions/io.apibuilder.common.v0.models.audit"}}},"generator_service_form":{"type":"object","title":"generator_service_form","required":["uri"],"properties":{"uri":{"type":"string"}}},"generator_with_service":{"type":"object","description":"Wraps a service and a generator providing easier access for applications.","title":"generator_with_service","required":["service","generator"],"properties":{"service":{"$ref":"#/definitions/generator_service"},"generator":{"$ref":"#/definitions/io.apibuilder.generator.v0.models.generator"}}},"item":{"type":"object","description":"When searching for content, the results of the search will be a list of items. Each item will have enough information to render for the user, including a type and item_guid to enable creating the appropriate link.","title":"item","required":["guid","detail","label"],"properties":{"guid":{"description":"Unique identifer for this item. By using a UUID, you can combine with the type to figure out the URI for the resource","type":"string","format":"uuid"},"detail":{"$ref":"#/definitions/item_detail"},"label":{"type":"string"},"description":{"type":"string"}}},"membership":{"type":"object","description":"A membership represents a user in a specific role to an organization. Memberships cannot be created directly. Instead you first create a membership request, then that request is either accepted or declined.","title":"membership","required":["guid","user","organization","role","audit"],"properties":{"guid":{"description":"Internal unique identifier for this membership.","type":"string","format":"uuid"},"user":{"$ref":"#/definitions/user"},"organization":{"$ref":"#/definitions/organization"},"role":{"description":"The role this user plays for this organization. Typically member or admin.","example":"member","type":"string"},"audit":{"$ref":"#/definitions/io.apibuilder.common.v0.models.audit"}}},"membership_request":{"type":"object","description":"A membership request represents a user requesting to join an organization with a specific role (e.g. as a member or an admin). Membership requests can be reviewed by any current admin of the organization who can either accept or decline the request.","title":"membership_request","required":["guid","user","organization","role","audit"],"properties":{"guid":{"description":"Internal unique identifier for this membership request.","type":"string","format":"uuid"},"user":{"$ref":"#/definitions/user"},"organization":{"$ref":"#/definitions/organization"},"role":{"description":"The requested role for membership to this organization. Typically member or admin.","example":"member","type":"string"},"audit":{"$ref":"#/definitions/io.apibuilder.common.v0.models.audit"}}},"move_form":{"type":"object","title":"move_form","required":["org_key"],"properties":{"org_key":{"description":"The key of the organization to which we are moving this item","type":"string"}}},"organization":{"type":"object","description":"An organization is used to group a set of applications together.","title":"organization","required":["guid","key","name","namespace","visibility","domains","audit"],"properties":{"guid":{"description":"Internal unique identifier for this organization.","type":"string","format":"uuid"},"key":{"description":"Used as a unique key in the URL path. Key is automatically derived from the organization name.","type":"string"},"name":{"description":"The name of this organization.","type":"string"},"namespace":{"description":"Global namespace for this organization.","example":"io.apicollective","type":"string"},"visibility":{"type":"string","enum":["user","organization","public"]},"domains":{"type":"array","items":{"$ref":"#/definitions/domain"}},"audit":{"$ref":"#/definitions/io.apibuilder.common.v0.models.audit"}}},"organization_form":{"type":"object","title":"organization_form","required":["name","namespace","visibility"],"properties":{"name":{"type":"string"},"key":{"description":"Defaults to a url friendy version of the name","type":"string"},"namespace":{"description":"Global namespace for this organization.","example":"io.apicollective","type":"string"},"visibility":{"type":"string","enum":["user","organization","public"]},"domains":{"example":"apibuilder.io","type":"array","items":{"type":"string"}}}},"original":{"type":"object","description":"Represents the original input used to create an application version","title":"original","required":["type","data"],"properties":{"type":{"type":"string","enum":["api_json","avro_idl","service_json","swagger"]},"data":{"type":"string"}}},"original_form":{"type":"object","title":"original_form","required":["data"],"properties":{"type":{"type":"string","enum":["api_json","avro_idl","service_json","swagger"]},"data":{"type":"string"}}},"password_reset":{"type":"object","description":"Allows a user to change their password with authentication from a token.","title":"password_reset","required":["token","password"],"properties":{"token":{"description":"Unique one time use token to change a password","type":"string"},"password":{"type":"string"}}},"password_reset_request":{"type":"object","description":"Create a password reset request - e.g. an email containing a one time URL to change a password","title":"password_reset_request","required":["email"],"properties":{"email":{"description":"The email address for which we generate the password reset.","type":"string"}}},"session":{"type":"object","description":"Represents a user sessions (e.g. user logged into site)","title":"session","required":["id","expires_at"],"properties":{"id":{"description":"Cryptographically secure session id","type":"string"},"expires_at":{"type":"string","format":"date-time"}}},"subscription":{"type":"object","description":"Represents a user that is currently subscribed to a publication","title":"subscription","required":["guid","organization","user","publication","audit"],"properties":{"guid":{"description":"Internal unique identifier for this subscription record","type":"string","format":"uuid"},"organization":{"$ref":"#/definitions/organization"},"user":{"$ref":"#/definitions/user"},"publication":{"type":"string","enum":["membership_requests.create","memberships.create","applications.create","versions.create"]},"audit":{"$ref":"#/definitions/io.apibuilder.common.v0.models.audit"}}},"subscription_form":{"type":"object","title":"subscription_form","required":["organization_key","user_guid","publication"],"properties":{"organization_key":{"type":"string"},"user_guid":{"type":"string","format":"uuid"},"publication":{"type":"string","enum":["membership_requests.create","memberships.create","applications.create","versions.create"]}}},"token":{"type":"object","description":"A token gives a user access to the API.","title":"token","required":["guid","user","masked_token","audit"],"properties":{"guid":{"description":"Internal unique identifier for this token.","type":"string","format":"uuid"},"user":{"$ref":"#/definitions/user"},"masked_token":{"description":"The masked from of the token.","type":"string"},"description":{"description":"optional description to help the user manage the token.","type":"string"},"audit":{"$ref":"#/definitions/io.apibuilder.common.v0.models.audit"}}},"token_form":{"type":"object","title":"token_form","required":["user_guid"],"properties":{"user_guid":{"description":"The user for which we are creating the token.","type":"string","format":"uuid"},"description":{"type":"string"}}},"user":{"type":"object","description":"A user is a top level person interacting with the api doc server.","title":"user","required":["guid","email","nickname","audit"],"properties":{"guid":{"description":"Internal unique identifier for this user.","type":"string","format":"uuid"},"email":{"type":"string"},"nickname":{"description":"Public unique identifier for this user.","type":"string"},"name":{"type":"string"},"audit":{"$ref":"#/definitions/io.apibuilder.common.v0.models.audit"}}},"user_form":{"type":"object","title":"user_form","required":["email","password"],"properties":{"email":{"type":"string"},"password":{"type":"string"},"nickname":{"description":"Defaults to a unique identifier based on email address","type":"string"},"name":{"type":"string"}}},"user_summary":{"type":"object","description":"Summary of a user sufficient for display","title":"user_summary","required":["guid","nickname"],"properties":{"guid":{"type":"string","format":"uuid"},"nickname":{"type":"string"}}},"user_update_form":{"type":"object","title":"user_update_form","required":["email","nickname"],"properties":{"email":{"type":"string"},"nickname":{"type":"string"},"name":{"type":"string"}}},"validation":{"type":"object","description":"Used only to validate json files - used as a resource where http status code defines success","title":"validation","required":["valid","errors"],"properties":{"valid":{"description":"If true, the json schema is valid. If false, there is at least one validation error.","type":"boolean"},"errors":{"description":"Contains any validation errors that result from parsing the json document. If empty, the document is valid.","default":"[]","type":"array","items":{"type":"string"}}}},"version":{"type":"object","description":"Represents a unique version of the application.","title":"version","required":["guid","organization","application","version","service","audit"],"properties":{"guid":{"description":"Internal unique identifier for this version.","type":"string","format":"uuid"},"organization":{"$ref":"#/definitions/io.apibuilder.common.v0.models.reference"},"application":{"$ref":"#/definitions/io.apibuilder.common.v0.models.reference"},"version":{"description":"The tag for this version. Can be anything, but if semver style version number is used, we automatically correctly sort by version number to find latest. Otherwise latest version is considered to be the most recently created.","example":"1.0.0","type":"string"},"original":{"$ref":"#/definitions/original"},"service":{"$ref":"#/definitions/io.apibuilder.spec.v0.models.service"},"audit":{"$ref":"#/definitions/io.apibuilder.common.v0.models.audit"}}},"version_form":{"type":"object","title":"version_form","required":["original_form"],"properties":{"original_form":{"$ref":"#/definitions/original_form"},"visibility":{"type":"string","enum":["user","organization","public"]}}},"watch":{"type":"object","description":"Users can watch individual applications which enables features like receiving an email notification when there is a new version of an application.","title":"watch","required":["guid","user","organization","application","audit"],"properties":{"guid":{"description":"Internal unique identifier for this watch","type":"string","format":"uuid"},"user":{"$ref":"#/definitions/user"},"organization":{"$ref":"#/definitions/organization"},"application":{"$ref":"#/definitions/application"},"audit":{"$ref":"#/definitions/io.apibuilder.common.v0.models.audit"}}},"watch_form":{"type":"object","title":"watch_form","required":["user_guid","organization_key","application_key"],"properties":{"user_guid":{"type":"string","format":"uuid"},"organization_key":{"type":"string"},"application_key":{"type":"string"}}},"diff":{"type":"object","description":"Represents a single diff in an application","title":"diff","allOf":[{"$ref":"#/definitions/diff_breaking"},{"$ref":"#/definitions/diff_non_breaking"}]},"item_detail":{"type":"object","description":"Identifies the specific type of item that was indexed by search","title":"item_detail","allOf":[{"$ref":"#/definitions/application_summary"}]}}}